IMP logo
IMP Reference Guide  2.5.0
The Integrative Modeling Platform
IMP::core::QuadConstraint Class Reference

Apply a QuadFunction to a Quad. More...

#include <IMP/core/QuadConstraint.h>

+ Inheritance diagram for IMP::core::QuadConstraint:

Detailed Description

Apply a QuadFunction to a Quad.

The score state is passed up to two QuadModifiers, one to apply before evaluation and the other after. The one after should take a DerivativeAccumulator as its last argument for QuadModifier::apply() and will only be called if the score was computed with derivatives.

See Also

Definition at line 31 of file QuadConstraint.h.

Public Member Functions

 QuadConstraint (QuadModifier *before, QuadDerivativeModifier *after, const ParticleQuad &vt, std::string name="QuadConstraint %1%")
 QuadConstraint (QuadModifier *before, QuadDerivativeModifier *after, Model *m, const ParticleIndexQuad &vt, std::string name="QuadConstraint %1%")
virtual std::string get_type_name () const
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
- Public Member Functions inherited from IMP::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::ScoreState
 ScoreState (Model *m, std::string name)
void after_evaluate (DerivativeAccumulator *accpt)
 Do post evaluation work if needed. More...
void before_evaluate ()
 Force update of the structure. More...
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
bool get_has_required_score_states () const
 Return whether score states are computed. More...
ModelObjectsTemp get_inputs () const
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
Modelget_model () const
ModelObjectsTemp get_outputs () const
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
CheckLevel get_check_level () const
LogLevel get_log_level () const
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)
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
virtual void handle_set_has_required_score_states (bool)
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
virtual void do_destroy ()

Constructor & Destructor Documentation

IMP::core::QuadConstraint::QuadConstraint ( QuadModifier before,
QuadDerivativeModifier after,
const ParticleQuad vt,
std::string  name = "QuadConstraint %1%" 
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the model/index constructor.

Definition at line 43 of file QuadConstraint.h.

Member Function Documentation

virtual ModelObjectsTemp IMP::core::QuadConstraint::do_get_inputs ( ) const

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::ModelObject.

virtual ModelObjectsTemp IMP::core::QuadConstraint::do_get_outputs ( ) const

Get any Particle, Container or other ModelObjects changed by this during evaluation. This is only useful for ScoreStates, at the moment.

Implements IMP::ModelObject.

virtual ::IMP::VersionInfo IMP::core::QuadConstraint::get_version_info ( ) const

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 66 of file QuadConstraint.h.

The documentation for this class was generated from the following file: