IMP logo
IMP Reference Guide  2.6.0
The Integrative Modeling Platform
PairConstraint.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-38828/imp-2.6.0/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-38828/imp-2.6.0/tools/build/container_templates/core/ClassnameConstraint.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/core/PairConstraint.h
7  * \brief Use a PairModifier applied to a ParticlePairsTemp to
8  * maintain an invariant
9  *
10  * Copyright 2007-2016 IMP Inventors. All rights reserved.
11  */
12 
13 #ifndef IMPCORE_PAIR_CONSTRAINT_H
14 #define IMPCORE_PAIR_CONSTRAINT_H
15 
16 #include <IMP/core/core_config.h>
17 #include <IMP/internal/TupleConstraint.h>
18 #include <IMP/PairModifier.h>
20 
21 IMPCORE_BEGIN_NAMESPACE
22 //! Apply a PairFunction to a Pair
23 /** The score state is passed up to two PairModifiers, one to
24  apply before evaluation and the other after. The one after
25  should take a DerivativeAccumulator as its last argument for
26  PairModifier::apply() and will only be called if
27  the score was computed with derivatives.
28 
29  \see container::PairsConstraint
30  */
32 #if defined(IMP_DOXYGEN) || defined(SWIG)
33  public Constraint
34 #else
35  public IMP::internal::TupleConstraint<PairModifier,
36  PairDerivativeModifier>
37 #endif
38  {
39  public:
40  /** \deprecated_at{2.1} Use the model/index constructor.
41  */
42  IMPCORE_DEPRECATED_METHOD_DECL(2.1)
44  PairDerivativeModifier *after, const ParticlePair& vt,
45  std::string name = "PairConstraint %1%")
46  : IMP::internal::TupleConstraint<
47  PairModifier, PairDerivativeModifier>(before, after, vt,
48  name) {
49  IMPCORE_DEPRECATED_METHOD_DEF(2.1, "Use the model/index constructor.");
50  }
51 
53  PairDerivativeModifier *after, Model *m,
54  const ParticleIndexPair& vt,
55  std::string name = "PairConstraint %1%")
56  : IMP::internal::TupleConstraint<
57  PairModifier, PairDerivativeModifier>(before, after, m,
58  vt, name) {}
59 
60 #if defined(IMP_DOXYGEN) || defined(SWIG)
61  protected:
62  void do_update_attributes();
63  void do_update_derivatives(DerivativeAccumulator *da);
64  virtual ModelObjectsTemp do_get_inputs() const;
65  virtual ModelObjectsTemp do_get_outputs() const;
67 #endif
68 };
69 
70 IMPCORE_END_NAMESPACE
71 
72 #endif /* IMPCORE_PAIR_CONSTRAINT_H */
A Modifier on ParticlePairsTemp.
Apply a PairFunction to a Pair.
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
A base class for modifiers of ParticlePairsTemp.
Definition: PairModifier.h:32
Implement a constraint on the Model.
Definition: Constraint.h:49
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
A Modifier on ParticlePairsTemp.
Class for adding derivatives from restraints to the model.