IMP
2.0.1
The Integrative Modeling Platform
|
Abstract score function. More...
#include <IMP/kernel/SingletonScore.h>
Public Types | |
typedef Particle * | Argument |
typedef ParticleIndex | IndexArgument |
typedef SingletonModifier | Modifier |
typedef Particle * | PassArgument |
typedef ParticleIndex | PassIndexArgument |
Public Member Functions | |
SingletonScore (std::string name="SingletonScore %1%") | |
Restraints | create_current_decomposition (Model *m, ParticleIndex vt) const |
virtual double | evaluate (Particle *vt, DerivativeAccumulator *da) const |
Compute the score and the derivative if needed. | |
virtual double | evaluate_if_good_index (Model *m, ParticleIndex vt, DerivativeAccumulator *da, double max) const |
Compute the score and the derivative if needed. | |
virtual double | evaluate_if_good_indexes (Model *m, const ParticleIndexes &o, DerivativeAccumulator *da, double max, unsigned int lower_bound, unsigned int upper_bound) const |
virtual double | evaluate_index (Model *m, ParticleIndex vt, DerivativeAccumulator *da) const |
Compute the score and the derivative if needed. | |
virtual double | evaluate_indexes (Model *m, const ParticleIndexes &o, DerivativeAccumulator *da, unsigned int lower_bound, unsigned int upper_bound) const |
ContainersTemp | get_input_containers (Particle *p) const |
ParticlesTemp | get_input_particles (Particle *p) const |
ModelObjectsTemp | get_inputs (Model *m, const ParticleIndexes &pis) 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) |
Protected Member Functions | |
virtual Restraints | do_create_current_decomposition (Model *m, ParticleIndex vt) const |
virtual ModelObjectsTemp | do_get_inputs (Model *m, const ParticleIndexes &pis) const =0 |
Protected Member Functions inherited from IMP::base::Object | |
Object (std::string name) | |
Construct an object with the given name. More... | |
Related Functions | |
(Note that these are not member functions.) | |
typedef IMP::base::Vector < IMP::base::WeakPointer < SingletonScore > > | SingletonScoresTemp |
Related Functions inherited from IMP::base::Object | |
typedef IMP::base::Vector < IMP::base::WeakPointer < Object > > | ObjectsTemp |
SingletonScores will evaluate the score and derivatives for the passed particles. Use in conjunction with various restraints such as IMP::core::SingletonsRestraint or IMP::core::SingletonRestraint.
Implementers should check out IMP_SINGLETON_SCORE().
Definition at line 33 of file kernel/SingletonScore.h.
Restraints IMP::kernel::SingletonScore::create_current_decomposition | ( | Model * | m, |
ParticleIndex | vt | ||
) | const |
Decompose this pair score acting on the pair into a set of restraints. The scoring function and derivatives should be equal to the current score. The defualt implementation just returns this object bound to the pair.
|
protectedvirtual |
Overide this to return your own decomposition.
|
protectedpure virtual |
Override if this reads other objects during evaluate.
|
virtual |
Implementations for these are provided by the IMP_SINGLETON_SCORE() macro.
|
virtual |
Implementations for these are provided by the IMP_SINGLETON_SCORE() macro.
ContainersTemp IMP::kernel::SingletonScore::get_input_containers | ( | Particle * | p | ) | const |
Get the set of input containers when this modifier is applied to the arguments.
ParticlesTemp IMP::kernel::SingletonScore::get_input_particles | ( | Particle * | p | ) | const |
Get the set of particles read when applied to the arguments.
ModelObjectsTemp IMP::kernel::SingletonScore::get_inputs | ( | Model * | m, |
const ParticleIndexes & | pis | ||
) | const |
Get all the ModelObject objects that are read when the referenced particles are passed in.
|
related |
Pass a set of objects.
Definition at line 95 of file kernel/base_types.h.