IMP logo
IMP Reference Guide  2.13.0
The Integrative Modeling Platform
IMP::misc::LogPairScore Class Reference

Track the pairs of particles passed. More...

#include <IMP/misc/LogPairScore.h>

+ Inheritance diagram for IMP::misc::LogPairScore:

Detailed Description

Track the pairs of particles passed.

Primarily for testing.

Definition at line 21 of file LogPairScore.h.

Public Member Functions

 LogPairScore ()
 create with an empty map More...
 
void clear ()
 Clear the lst of pairs. More...
 
virtual ModelObjectsTemp do_get_inputs (Model *, const ParticleIndexes &) const
 Overload this method to specify the inputs. More...
 
virtual double evaluate_index (Model *m, const ParticleIndexPair &p, DerivativeAccumulator *da) const
 Compute the score and the derivative if needed. More...
 
bool get_contains (const ParticlePair &pp) const
 Return true if the pair is in the list. More...
 
ParticlePairsTemp get_particle_pairs () const
 Get a list of all pairs (without multiplicity) More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
 IMP_PAIR_SCORE_METHODS (LogPairScore)
 
- Public Member Functions inherited from IMP::PairScore
 PairScore (std::string name="PairScore %1%")
 
Restraints create_current_decomposition (Model *m, const ParticleIndexPair &vt) const
 
virtual double evaluate_if_good_index (Model *m, const ParticleIndexPair &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 ParticleIndexPairs &o, DerivativeAccumulator *da, double max, unsigned int lower_bound, unsigned int upper_bound) const
 
virtual double evaluate_indexes (Model *m, const ParticleIndexPairs &o, DerivativeAccumulator *da, unsigned int lower_bound, unsigned int upper_bound) 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
 
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

- Public Types inherited from IMP::PairScore
typedef ParticlePair Argument
 
typedef ParticleIndexPair IndexArgument
 
typedef PairModifier Modifier
 
typedef const ParticlePairPassArgument
 
typedef const ParticleIndexPairPassIndexArgument
 
- Protected Member Functions inherited from IMP::PairScore
virtual Restraints do_create_current_decomposition (Model *m, const ParticleIndexPair &vt) const
 Override this to return your own decomposition. More...
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::misc::LogPairScore::LogPairScore ( )

create with an empty map

Definition at line 26 of file LogPairScore.h.

Member Function Documentation

void IMP::misc::LogPairScore::clear ( )

Clear the lst of pairs.

Definition at line 48 of file LogPairScore.h.

virtual ModelObjectsTemp IMP::misc::LogPairScore::do_get_inputs ( Model m,
const ParticleIndexes pis 
) const
virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

Definition at line 30 of file LogPairScore.h.

virtual double IMP::misc::LogPairScore::evaluate_index ( Model m,
const ParticleIndexPair vt,
DerivativeAccumulator da 
) const
virtual

Compute the score and the derivative if needed.

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

Implements IMP::PairScore.

bool IMP::misc::LogPairScore::get_contains ( const ParticlePair pp) const

Return true if the pair is in the list.

Definition at line 50 of file LogPairScore.h.

ParticlePairsTemp IMP::misc::LogPairScore::get_particle_pairs ( ) const

Get a list of all pairs (without multiplicity)

Definition at line 38 of file LogPairScore.h.

virtual ::IMP::VersionInfo IMP::misc::LogPairScore::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 35 of file LogPairScore.h.


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