IMP  2.1.0
The Integrative Modeling Platform
Public Member Functions | List of all members
IMP::core::MinimumRestraint Class Reference

Score based on the minimum scoring members of a set of restraints.

#include <IMP/core/MinimumRestraint.h>

+ Inheritance diagram for IMP::core::MinimumRestraint:

Public Member Functions

 MinimumRestraint (unsigned int num, const kernel::Restraints &rs=kernel::Restraints(), std::string name="MinimumRestraint %1%")
 
unsigned int add_restraint (kernel::Restraint *obj)
 
void add_restraints (const kernel::Restraints &objs)
 
void clear_caches ()
 
void clear_restraints ()
 
IMP::kernel::ModelObjectsTemp do_get_inputs () const
 
bool get_has_restraints ()
 
unsigned int get_number_of_restraints () const
 
kernel::Restraint * get_restraint (unsigned int i) const
 
kernel::Restraints get_restraints () const
 
virtual std::string get_type_name () const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object.
 
void remove_restraint (kernel::Restraint *d)
 
void remove_restraints (const kernel::Restraints &d)
 
void reserve_restraints (unsigned int sz)
 
void set_model (kernel::Model *m)
 
void set_restraints (const kernel::Restraints &ps)
 
void set_restraints_order (const kernel::Restraints &objs)
 
double unprotected_evaluate (IMP::DerivativeAccumulator *accum) const
 
- Public Member Functions inherited from IMP::kernel::Restraint
 Restraint (kernel::Model *m, std::string name)
 
 Restraint (std::string name="Restraint %1%")
 
void add_score_and_derivatives (ScoreAccumulator sa) const
 
Restraint * create_current_decomposition () const
 Decompose this restraint into constituent terms for the current conf. More...
 
Restraint * create_decomposition () const
 Decompose this restraint into constituent terms. More...
 
virtual ScoringFunction * create_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 (kernel::Model *m, std::string name)
 
 ModelObject (std::string name)
 
virtual void do_set_model (kernel::Model *)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed.
 
bool get_has_required_score_states () const
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
bool get_is_part_of_model () const
 
Model * get_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTemp & get_required_score_states () const
 
void set_has_dependencies (bool tf)
 
void set_has_required_score_states (bool tf)
 
- Public Member Functions inherited from IMP::base::Object
virtual void do_destroy ()
 
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::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
 
- Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
 Object ()
 

Detailed Description

Definition at line 23 of file MinimumRestraint.h.

Constructor & Destructor Documentation

IMP::core::MinimumRestraint::MinimumRestraint ( unsigned int  num,
const kernel::Restraints &  rs = kernel::Restraints(),
std::string  name = "MinimumRestraint %1%" 
)

Score based on the num minimum restraints from rs. The restraints must already be registered with the model (either by being added to the model scoring function, upon constructior or having kernel::Restraint::set_model() called on them.

Member Function Documentation

void IMP::core::MinimumRestraint::clear_caches ( )
virtual

Objects can have internal caches. This method resets them returning the object to its just-initialized state.

Reimplemented from IMP::base::Object.

IMP::kernel::ModelObjectsTemp IMP::core::MinimumRestraint::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::kernel::ModelObject.

void IMP::core::MinimumRestraint::set_model ( kernel::Model *  m)
virtual
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the constructor that takes a Model.

Reimplemented from IMP::kernel::ModelObject.

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