IMP  2.0.1
The Integrative Modeling Platform
IMP::container::MinimumPairRestraint Class Reference

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

#include <IMP/container/MinimumPairRestraint.h>

+ Inheritance diagram for IMP::container::MinimumPairRestraint:

Public Member Functions

 MinimumPairRestraint (PairScore *f, PairContainerAdaptor c, unsigned int n=1, std::string name="MinimumPairRestraint %1%")
 
IMP::ModelObjectsTemp do_get_inputs () const
 
void set_n (unsigned int n)
 Set the number of lowest scores to use.
 
double unprotected_evaluate (IMP::DerivativeAccumulator *accum) const
 
- Public Member Functions inherited from IMP::kernel::Restraint
 Restraint (Model *m, std::string name)
 
void add_score_and_derivatives (ScoreAccumulator sa) const
 
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
 
ContainersTemp get_input_containers () const
 
ParticlesTemp get_input_particles () const
 
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::kernel::ModelObject
 ModelObject (Model *m, std::string name)
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
Modelget_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)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::kernel::Restraint
virtual void do_add_score_and_derivatives (ScoreAccumulator sa) const
 
virtual Restraints do_create_current_decomposition () const
 
virtual Restraints do_create_decomposition () const
 
ModelObjectsTemp do_get_outputs () const
 
virtual void do_update_dependencies ()
 

Detailed Description

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 29 of file MinimumPairRestraint.h.

Constructor & Destructor Documentation

IMP::container::MinimumPairRestraint::MinimumPairRestraint ( PairScore f,
PairContainerAdaptor  c,
unsigned int  n = 1,
std::string  name = "MinimumPairRestraint %1%" 
)

n is the number of LCMinimum scores to use.

Member Function Documentation

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

Override if this reads other objects during evaluate.

Implements IMP::kernel::ModelObject.


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