IMP::core::PairConstraint Class Reference
Apply a PairFunction to a Pair. More...
#include <IMP/core/PairConstraint.h>
Inheritance diagram for IMP::core::PairConstraint:Public Member Functions | |
| PairConstraint (PairModifier *before, PairDerivativeModifier *after, const ParticlePair &vt, std::string name="PairConstraint %1%") | |
| Public Member Functions inherited from IMP::kernel::Constraint | |
| Constraint (Model *m, std::string name="Constraint %1%") | |
| virtual void | do_after_evaluate (DerivativeAccumulator *da) |
| virtual void | do_before_evaluate () |
| Public Member Functions inherited from IMP::kernel::ScoreState | |
| ScoreState (Model *m, std::string name="ScoreState %1%") | |
| void | after_evaluate (DerivativeAccumulator *accpt) |
| Do post evaluation work if needed. | |
| void | before_evaluate () |
| Force update of the structure. | |
| ContainersTemp | get_input_containers () const |
| ParticlesTemp | get_input_particles () const |
| ContainersTemp | get_output_containers () const |
| ParticlesTemp | get_output_particles () const |
| Public Member Functions inherited from IMP::kernel::ModelObject | |
| ModelObject (Model *m, std::string name) | |
| ModelObjectsTemp | get_inputs () const |
| ModelObjectsTemps | get_interactions () const |
| Model * | get_model () const |
| ModelObjectsTemp | get_outputs () const |
| Public Member Functions inherited from IMP::base::Object | |
| virtual void | clear_caches () |
| virtual IMP::base::VersionInfo | get_version_info () const =0 |
| Get information about the module and version of the object. | |
| void | set_check_level (CheckLevel l) |
| void | set_log_level (LogLevel l) |
| Set the logging level used in this object. More... | |
| void | set_was_used (bool tf) const |
| void | show (std::ostream &out=std::cout) const |
| const std::string & | get_name () const |
| void | set_name (std::string name) |
Protected Member Functions | |
| virtual ModelObjectsTemp | do_get_inputs () const |
| virtual ModelObjectsTemp | do_get_outputs () const |
| void | do_update_attributes () |
| void | do_update_derivatives (DerivativeAccumulator *da) |
Additional Inherited Members | |
| Related Functions inherited from IMP::kernel::Constraint | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < Constraint > > | ConstraintsTemp |
Detailed Description
The score state is passed up to two PairModifiers, one to apply before evaluation and the other after. The one after should take a DerivativeAccumulator as its last argument for PairModifier::apply() and will only be called if the score was computed with derivatives.
- See Also
- container::PairsConstraint
Definition at line 31 of file PairConstraint.h.
Constructor & Destructor Documentation
| IMP::core::PairConstraint::PairConstraint | ( | PairModifier * | before, |
| PairDerivativeModifier * | after, | ||
| const ParticlePair & | vt, | ||
| std::string | name = "PairConstraint %1%" |
||
| ) |
before and after are the modifiers to apply before and after evaluate.
Definition at line 43 of file PairConstraint.h.
Member Function Documentation
|
protectedvirtual |
Override if this reads other objects during evaluate.
Implements IMP::kernel::ModelObject.
|
protectedvirtual |
Override if this writes other objects during evaluate.
Implements IMP::kernel::ModelObject.
The documentation for this class was generated from the following file: