IMP  2.2.1
The Integrative Modeling Platform
Public Member Functions | List of all members
IMP::container::PredicateSingletonsRestraint Class Reference

Applies a SingletonScore to each Singleton in a list based on a predicate. More...

#include <IMP/container/PredicateSingletonsRestraint.h>

+ Inheritance diagram for IMP::container::PredicateSingletonsRestraint:

Public Member Functions

 PredicateSingletonsRestraint (SingletonPredicate *pred, SingletonContainerAdaptor input, std::string name="PredicateSingletonsRestraint %1%")
 
void do_add_score_and_derivatives (IMP::ScoreAccumulator sa) const
 
IMP::kernel::ModelObjectsTemp do_get_inputs () const
 
kernel::ParticleIndexes get_indexes (int predicate_value) 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 set_is_complete (bool tf)
 
void set_score (int predicate_value, kernel::SingletonScore *score)
 
void set_unknown_score (kernel::SingletonScore *score)
 
- Public Member Functions inherited from IMP::kernel::Restraint
 Restraint (kernel::Model *m, std::string name)
 
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
 
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)
 
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
 
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 clear_caches ()
 
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 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...
 

Detailed Description

This restraint uses a passed predicate to choose which score to apply to each tuple in the input container. The selections are cached, making it substantially faster than using a core::TypedPairScore.

Note
The ordering of particles within a tuple may vary depending on the input container used. You may need to call set_score() with several different predicate values for different orderings.

Definition at line 34 of file PredicateSingletonsRestraint.h.

Member Function Documentation

void IMP::container::PredicateSingletonsRestraint::do_add_score_and_derivatives ( IMP::ScoreAccumulator  sa) const
virtual

A restraint should override this to compute the score and derivatives.

Reimplemented from IMP::kernel::Restraint.

IMP::kernel::ModelObjectsTemp IMP::container::PredicateSingletonsRestraint::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.

kernel::ParticleIndexes IMP::container::PredicateSingletonsRestraint::get_indexes ( int  predicate_value) const

return the indexes of all particles for a given predicate value.

Definition at line 63 of file PredicateSingletonsRestraint.h.

void IMP::container::PredicateSingletonsRestraint::set_is_complete ( bool  tf)

By default, it is an error if the predicate returns a value that is not known. If this is false, then they are silently skipped.

Definition at line 60 of file PredicateSingletonsRestraint.h.

void IMP::container::PredicateSingletonsRestraint::set_score ( int  predicate_value,
kernel::SingletonScore *  score 
)

Apply the passed score to all pairs whose predicate values match the passed value.

void IMP::container::PredicateSingletonsRestraint::set_unknown_score ( kernel::SingletonScore *  score)

Apply this score to any pair whose predicate value does not match one passed to set_score().

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