IMP logo
IMP Reference Guide  2.5.0
The Integrative Modeling Platform
PairRestraint.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-6636/imp-2.5.0/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-6636/imp-2.5.0/tools/build/container_templates/core/ClassnameRestraint.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/core/PairRestraint.h
7  * \brief Apply a PairScore to a Pair.
8  *
9  * Copyright 2007-2015 IMP Inventors. All rights reserved.
10  *
11  */
12 
13 #ifndef IMPCORE_PAIR_RESTRAINT_H
14 #define IMPCORE_PAIR_RESTRAINT_H
15 
16 #include <IMP/core/core_config.h>
17 
18 #include <IMP/internal/TupleRestraint.h>
19 #include <IMP/PairScore.h>
20 
21 #include <iostream>
22 
23 IMPCORE_BEGIN_NAMESPACE
24 
25 //! Applies a PairScore to a Pair.
26 /** This restraint stores a Pair.
27  \see PairRestraint
28  */
30 #if defined(SWIG) || defined(IMP_DOXYGEN)
31  public Restraint
32 #else
33  public IMP::internal::TupleRestraint<PairScore>
34 #endif
35  {
36  public:
37  //! Create the restraint.
38  /** This function takes the function to apply to the
39  stored Pair and the Pair.
40  */
42  std::string name = "PairRestraint %1%")
43  : IMP::internal::TupleRestraint<PairScore>(ss, m, vt, name) {
44  }
45 
46  //! Create the restraint.
47  /** This function takes the function to apply to the
48  stored Pair and the Pair.
49  \deprecated_at{2.5} Use the index-based constructor instead.
50  */
51  IMPCORE_DEPRECATED_METHOD_DECL(2.5)
53  std::string name = "PairRestraint %1%")
54  : IMP::internal::TupleRestraint<PairScore>(
55  ss, IMP::internal::get_model(vt),
56  IMP::internal::get_index(vt), name) {
57  IMPCORE_DEPRECATED_METHOD_DEF(2.5,
58  "Use the index-based constructor instead.");
59  }
60 
61 #if defined(SWIG) || defined(IMP_DOXYGEN)
62  protected:
63  double unprotected_evaluate(IMP::DerivativeAccumulator *accum) const;
64  IMP::ModelObjectsTemp do_get_inputs() const;
66 #endif
67 };
68 
69 IMPCORE_END_NAMESPACE
70 
71 #endif /* IMPCORE_PAIR_RESTRAINT_H */
Abstract class for scoring object(s) of type ParticleIndexPair.
Definition: PairScore.h:38
A class to store an fixed array of same-typed values.
Definition: Array.h:33
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
PairRestraint(Model *m, PairScore *ss, const ParticleIndexPair &vt, std::string name="PairRestraint %1%")
Create the restraint.
Definition: PairRestraint.h:41
Ints get_index(const ParticlesTemp &particles, const Subset &subset, const Subsets &excluded)
Define PairScore.
Applies a PairScore to a Pair.
Definition: PairRestraint.h:29
Class for adding derivatives from restraints to the model.
A restraint is a term in an IMP ScoringFunction.
Definition: Restraint.h:52