IMP logo
IMP Reference Guide  develop.4390929e3e,2024/11/12
The Integrative Modeling Platform
IMP::TripletScore Class Referenceabstract

Abstract class for scoring object(s) of type ParticleIndexTriplet. More...

#include <IMP/TripletScore.h>

+ Inheritance diagram for IMP::TripletScore:

Detailed Description

Abstract class for scoring object(s) of type ParticleIndexTriplet.

TripletScore will evaluate the score and derivatives for passed object(s) of type ParticleIndexTriplet.

Use in conjunction with various restraints such as IMP::container::TripletsRestraint or IMP::core::TripletRestraint. The restraints couple the score functions with appropriate lists of object(s) of type ParticleIndexTriplet.

It is possible to call the various evaluate* methods directly, but this is not recommended as they do not ensure that Model invariants (e.g. ScoreStates) are preserved. Use a Restraint or ScoringFunction to score the model instead.

Implementers should check out IMP_TRIPLET_SCORE_METHODS().

See Also
PredicateTripletRestraint

Definition at line 44 of file TripletScore.h.

Public Types

typedef ParticleTriplet Argument
 
typedef ParticleIndexTriplet IndexArgument
 
typedef TripletModifier Modifier
 
typedef const ParticleTripletPassArgument
 
typedef const
ParticleIndexTriplet
PassIndexArgument
 

Public Member Functions

 TripletScore (std::string name="TripletScore %1%")
 
Restraints create_current_decomposition (Model *m, const ParticleIndexTriplet &vt) const
 
virtual double evaluate_if_good_index (Model *m, const ParticleIndexTriplet &vt, DerivativeAccumulator *da, double max) const
 Compute the score and the derivative if needed, only if "good". More...
 
virtual double evaluate_if_good_indexes (Model *m, const ParticleIndexTriplets &o, DerivativeAccumulator *da, double max, unsigned int lower_bound, unsigned int upper_bound) const
 
virtual double evaluate_index (Model *m, const ParticleIndexTriplet &vt, DerivativeAccumulator *da) const =0
 Compute the score and the derivative if needed. More...
 
virtual double evaluate_indexes (Model *m, const ParticleIndexTriplets &o, DerivativeAccumulator *da, unsigned int lower_bound, unsigned int upper_bound) const
 Compute the score and the derivative if needed over a set. More...
 
virtual double evaluate_indexes_delta (Model *m, const ParticleIndexTriplets &o, DerivativeAccumulator *da, const std::vector< unsigned > &indexes, std::vector< double > &score) const
 Compute the change in score and the derivative if needed over a set. More...
 
virtual double evaluate_indexes_scores (Model *m, const ParticleIndexTriplets &o, DerivativeAccumulator *da, unsigned int lower_bound, unsigned int upper_bound, std::vector< double > &score) const
 Compute the score and the derivative if needed over a set. More...
 
- Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp get_inputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects read when the given list of particles is used. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
virtual VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
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)
 
virtual std::string get_type_name () const
 

Protected Member Functions

virtual Restraints do_create_current_decomposition (Model *m, const ParticleIndexTriplet &vt) const
 Override this to return your own decomposition. More...
 
- Protected Member Functions inherited from IMP::ParticleInputs
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const =0
 Overload this method to specify the inputs. More...
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

Restraints IMP::TripletScore::create_current_decomposition ( Model m,
const ParticleIndexTriplet vt 
) const

Decompose this TripletScore into a set of currently positive restraints over vt. The scoring function and derivatives should be equal to the current score. The default implementation returns a single restraint with this score bound to vt, or zero restraints if the score equals zero.

virtual Restraints IMP::TripletScore::do_create_current_decomposition ( Model m,
const ParticleIndexTriplet vt 
) const
protectedvirtual

Override this to return your own decomposition.

Reimplemented in IMP::container::MinimumTripletScore.

virtual double IMP::TripletScore::evaluate_if_good_index ( Model m,
const ParticleIndexTriplet vt,
DerivativeAccumulator da,
double  max 
) const
virtual

Compute the score and the derivative if needed, only if "good".

This functions similarly to evaluate_index(), but may terminate the computation early if the score is higher than max.

Returns
the score if score<= max or some arbitrary value > max otherwise.
virtual double IMP::TripletScore::evaluate_if_good_indexes ( Model m,
const ParticleIndexTriplets o,
DerivativeAccumulator da,
double  max,
unsigned int  lower_bound,
unsigned int  upper_bound 
) const
virtual

Compute the score and the derivative if needed over a set, only if "good". This functions similarly to evaluate_indexes(), but may terminate the computation early if the total score is higher than max.

Returns
the score if score<= max or some arbitrary value > max otherwise.
Note
An implementation for this is provided by the IMP_TRIPLET_SCORE_METHODS() macro.

Reimplemented in IMP::core::AngleTripletScore, and IMP::container::MinimumTripletScore.

virtual double IMP::TripletScore::evaluate_index ( Model m,
const ParticleIndexTriplet vt,
DerivativeAccumulator da 
) const
pure virtual

Compute the score and the derivative if needed.

Parameters
mthe model of vt
vtthe index in m of an object of type ParticleTriplet
daa DerivativeAccumulator that weights computed derivatives. If nullptr, derivatives will not be computed.

Implemented in IMP::core::AngleTripletScore, and IMP::container::MinimumTripletScore.

virtual double IMP::TripletScore::evaluate_indexes ( Model m,
const ParticleIndexTriplets o,
DerivativeAccumulator da,
unsigned int  lower_bound,
unsigned int  upper_bound 
) const
virtual

Compute the score and the derivative if needed over a set.

Parameters
mthe model of o
oobjects of type ParticleTriplet, specified by index
daa derivative accumulator that weights computed derivatives. If nullptr, derivatives will not be computed.
lower_boundindex of first item in o to evaluate
upper_boundindex one past last item in o to evaluate
Note
An implementation for this is provided by the IMP_TRIPLET_SCORE_METHODS() macro.

Reimplemented in IMP::core::AngleTripletScore, and IMP::container::MinimumTripletScore.

virtual double IMP::TripletScore::evaluate_indexes_delta ( Model m,
const ParticleIndexTriplets o,
DerivativeAccumulator da,
const std::vector< unsigned > &  indexes,
std::vector< double > &  score 
) const
virtual

Compute the change in score and the derivative if needed over a set.

The score for each o[indexes[x]] is updated in score[indexes[x]] and the total difference between the old and new score values (over the set) is returned.

Note
An implementation for this is provided by the IMP_TRIPLET_SCORE_METHODS() macro.

Reimplemented in IMP::core::AngleTripletScore, and IMP::container::MinimumTripletScore.

virtual double IMP::TripletScore::evaluate_indexes_scores ( Model m,
const ParticleIndexTriplets o,
DerivativeAccumulator da,
unsigned int  lower_bound,
unsigned int  upper_bound,
std::vector< double > &  score 
) const
virtual

Compute the score and the derivative if needed over a set.

Like regular evaluate_indexes(), but the score for each o[x] is also returned as score[x].

Note
An implementation for this is provided by the IMP_TRIPLET_SCORE_METHODS() macro.

Reimplemented in IMP::core::AngleTripletScore, and IMP::container::MinimumTripletScore.


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