IMP::QuadScore Class Reference

---

Detailed Description

Abstract score function.

QuadScores will evaluate the score and derivatives for the passed particles. Use in conjunction with various restraints such as IMP::core::QuadsRestraint or IMP::core::QuadRestraint.

Implementers should check out IMP_QUAD_SCORE().

Inheritance diagram for IMP::QuadScore:

List of all members.

Public Types
typedef ParticleQuad	Argument
typedef ParticleIndexQuad	IndexArgument

Public Member Functions
	QuadScore (std::string name="QuadScore %1%")
Restraints	create_current_decomposition (const ParticleQuad &vt) const
virtual double	evaluate (const ParticleQuad &vt, DerivativeAccumulator *da) const =0
	Compute the score and the derivative if needed.
virtual double	evaluate (const ParticleQuadsTemp &o, DerivativeAccumulator *da) const
virtual double	evaluate_if_good_index (Model *m, const ParticleIndexQuad &vt, DerivativeAccumulator *da, double max) const
	Compute the score and the derivative if needed.
virtual double	evaluate_if_good_indexes (Model *m, const ParticleIndexQuads &o, DerivativeAccumulator *da, double max) const
virtual double	evaluate_index (Model *m, const ParticleIndexQuad &vt, DerivativeAccumulator *da) const
	Compute the score and the derivative if needed.
virtual double	evaluate_indexes (Model *m, const ParticleIndexQuads &o, DerivativeAccumulator *da) const
virtual ContainersTemp	get_input_containers (Particle *p) const =0
virtual ParticlesTemp	get_input_particles (Particle *p) const =0
Public Member Functions inherited from IMP::base::Object
std::size_t	__hash__ () const
virtual std::string	get_type_name () const =0
	Return a string identifying the type of the object.
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.
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::base::Object
	Object (std::string name)

---

Member Function Documentation

Restraints IMP::QuadScore::create_current_decomposition

(

const ParticleQuad &

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.

Reimplemented in IMP::container::MinimumQuadScore.

virtual double IMP::QuadScore::evaluate ( const ParticleQuad &  vt, DerivativeAccumulator *  da  ) const

pure virtual

Compute the score and the derivative if needed.

virtual double IMP::QuadScore::evaluate ( const ParticleQuadsTemp &  o, DerivativeAccumulator *  da  ) const

virtual

Implementations for these are provided by the IMP_QUAD_SCORE() macro.

virtual double IMP::QuadScore::evaluate_if_good_index ( Model *  m, const ParticleIndexQuad &  vt, DerivativeAccumulator *  da, double  max  ) const

virtual

Compute the score and the derivative if needed.

virtual double IMP::QuadScore::evaluate_if_good_indexes ( Model *  m, const ParticleIndexQuads &  o, DerivativeAccumulator *  da, double  max  ) const

virtual

Implementations for these are provided by the IMP_QUAD_SCORE() macro.

virtual double IMP::QuadScore::evaluate_index ( Model *  m, const ParticleIndexQuad &  vt, DerivativeAccumulator *  da  ) const

virtual

Compute the score and the derivative if needed.

virtual double IMP::QuadScore::evaluate_indexes ( Model *  m, const ParticleIndexQuads &  o, DerivativeAccumulator *  da  ) const

virtual

Implementations for these are provided by the IMP_QUAD_SCORE() macro.

virtual ContainersTemp IMP::QuadScore::get_input_containers ( Particle *  p ) const

pure virtual

Get the set of input containers when this modifier is applied to the arguments.

virtual ParticlesTemp IMP::QuadScore::get_input_particles ( Particle *  p ) const

pure virtual

Get the set of particles read when applied to the arguments.

---

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

• QuadScore.h