IMP logo
IMP Reference Guide  2.6.0
The Integrative Modeling Platform
IMP::container::MinimumTripletRestraint Class Reference

Score based on the min or max TripletScore over a set. More...

#include <IMP/container/MinimumTripletRestraint.h>

+ Inheritance diagram for IMP::container::MinimumTripletRestraint:

Detailed Description

Score based on the min or max TripletScore over a set.

The score is evaluated for each of the VALUETYPE in the container and the value of the min or max n scores is used. That is, if n is 1, the value of the restraint is the value of the min or max score over the container.

Definition at line 28 of file MinimumTripletRestraint.h.

Public Member Functions

 MinimumTripletRestraint (TripletScore *f, TripletContainerAdaptor c, unsigned int n=1, std::string name="MinimumTripletRestraint %1%")
 
IMP::ModelObjectsTemp do_get_inputs () const
 
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...
 
void set_n (unsigned int n)
 Set the number of lowest scores to use. More...
 
double unprotected_evaluate (IMP::DerivativeAccumulator *accum) const
 
- Public Member Functions inherited from IMP::Restraint
 Restraint (Model *m, std::string name)
 
void add_score_and_derivatives (ScoreAccumulator sa) const
 Perform the actual restraint scoring. More...
 
Restraintcreate_current_decomposition () const
 Decompose this restraint into constituent terms for the current conf. More...
 
Restraintcreate_decomposition () const
 Decompose this restraint into constituent terms. More...
 
virtual ScoringFunctioncreate_scoring_function (double weight=1.0, double max=NO_MAX) const
 Create a scoring function with only this restraint. More...
 
virtual double get_last_score () const
 
double get_score () const
 
bool get_was_good () const
 
void set_weight (Float weight)
 
Float get_weight () const
 
double get_maximum_score () const
 
void set_maximum_score (double s)
 
- 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)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Restraint
virtual void do_add_score_and_derivatives (ScoreAccumulator sa) const
 A restraint should override this to compute the score and derivatives. More...
 
virtual Restraints do_create_current_decomposition () const
 
virtual Restraints do_create_decomposition () const
 
ModelObjectsTemp do_get_outputs () const
 
- 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::container::MinimumTripletRestraint::MinimumTripletRestraint ( TripletScore f,
TripletContainerAdaptor  c,
unsigned int  n = 1,
std::string  name = "MinimumTripletRestraint %1%" 
)

n is the number of LCMinimum scores to use.

Member Function Documentation

IMP::ModelObjectsTemp IMP::container::MinimumTripletRestraint::do_get_inputs ( ) const
virtual

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 ::IMP::VersionInfo IMP::container::MinimumTripletRestraint::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 44 of file MinimumTripletRestraint.h.

void IMP::container::MinimumTripletRestraint::set_n ( unsigned int  n)

Set the number of lowest scores to use.

Definition at line 48 of file MinimumTripletRestraint.h.


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