IMP logo
Public Member Functions | Static Public Member Functions | Protected Member Functions
IMP::core::TripletConstraint Class Reference

Detailed Description

Apply a TripletFunction to a Triplet.

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

See also:
container::TripletsConstraint
+ Inheritance diagram for IMP::core::TripletConstraint:

List of all members.

Public Member Functions

 TripletConstraint (TripletModifier *before, TripletDerivativeModifier *after, const ParticleTriplet &vt, std::string name="TripletConstraint %1%")
void set_after_evaluate_modifier (TripletDerivativeModifier *f)
 Apply this modifier to all the elements after an evaluate.
void set_before_evaluate_modifier (TripletModifier *f)
 Apply this modifier to all the elements before an evaluate.
- Public Member Functions inherited from IMP::Constraint
 Constraint (Model *m, std::string name="Constraint %1%")
- Public Member Functions inherited from IMP::ScoreState
 ScoreState (Model *m, std::string name="ScoreState %1%")
void after_evaluate (DerivativeAccumulator *accpt)
void before_evaluate ()
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
ModelObjectsTemp get_inputs () const
Modelget_model () const
ModelObjectsTemp get_outputs () const
- Public Member Functions inherited from IMP::base::Object
std::size_t __hash__ () const
virtual std::string get_type_name () const =0
 Return a string identifying the type of the object.
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.
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)

Static Public Member Functions

static TripletConstraintget_from (IMP::base::Object *o)

Protected Member Functions

void do_update_attributes ()
void do_update_derivatives (DerivativeAccumulator *da)
virtual ContainersTemp get_input_containers () const
virtual ParticlesTemp get_input_particles () const
virtual ContainersTemp get_output_containers () const
virtual ParticlesTemp get_output_particles () const

Constructor & Destructor Documentation

IMP::core::TripletConstraint::TripletConstraint ( TripletModifier before,
TripletDerivativeModifier after,
const ParticleTriplet &  vt,
std::string  name = "TripletConstraint %1%" 
)

before and after are the modifiers to apply before and after evaluate.


Member Function Documentation

void IMP::core::TripletConstraint::set_after_evaluate_modifier ( TripletDerivativeModifier f)

Apply this modifier to all the elements after an evaluate.

void IMP::core::TripletConstraint::set_before_evaluate_modifier ( TripletModifier f)

Apply this modifier to all the elements before an evaluate.


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

Generated on Tue May 22 2012 23:33:32 for IMP by doxygen 1.8.1