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

#include <IMP/QuadScore.h>

Inheritance diagram for IMP::QuadScore:

Detailed Description

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

QuadScore will evaluate the score and derivatives for passed object(s) of type ParticleIndexQuad.

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

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_QUAD_SCORE().

See Also: PredicateQuadRestraint

Definition at line 42 of file QuadScore.h.

Public Types
typedef ParticleQuad	Argument

typedef ParticleIndexQuad	IndexArgument

typedef QuadModifier	Modifier

typedef const ParticleQuad &	PassArgument

typedef const ParticleIndexQuad &	PassIndexArgument

Public Member Functions
	QuadScore (std::string name="QuadScore %1%")

Restraints	create_current_decomposition (Model *m, const ParticleIndexQuad &vt) 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, only if "good". More...

virtual double	evaluate_if_good_indexes (Model m, const ParticleIndexQuads &o, DerivativeAccumulator da, double max, unsigned int lower_bound, unsigned int upper_bound) const

virtual double	evaluate_index (Model m, const ParticleIndexQuad &vt, DerivativeAccumulator da) const =0
	Compute the score and the derivative if needed. More...

virtual double	evaluate_indexes (Model m, const ParticleIndexQuads &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 ParticleIndexQuads &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 ParticleIndexQuads &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 ParticleIndexQuad &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::QuadScore::create_current_decomposition	(	Model *	m,
		const ParticleIndexQuad &	vt
	)		const

Decompose this QuadScore 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::QuadScore::do_create_current_decomposition	(	Model *	m,
		const ParticleIndexQuad &	vt
	)		const

protectedvirtual

Override this to return your own decomposition.

Reimplemented in IMP::container::MinimumQuadScore.

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, 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::QuadScore::evaluate_if_good_indexes	(	Model *	m,
		const ParticleIndexQuads &	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: Implementations for these are provided by the IMP_QUAD_SCORE() macro.

Reimplemented in IMP::container::MinimumQuadScore.

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

pure virtual

Compute the score and the derivative if needed.

Parameters

m	the model of vt
vt	the index in m of an object of type ParticleQuad
da	a DerivativeAccumulator that weights computed derivatives. If nullptr, derivatives will not be computed.

Implemented in IMP::container::MinimumQuadScore.

virtual double IMP::QuadScore::evaluate_indexes	(	Model *	m,
		const ParticleIndexQuads &	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

m	the model of o
o	objects of type ParticleQuad, specified by index
da	a derivative accumulator that weights computed derivatives. If nullptr, derivatives will not be computed.
lower_bound	index of first item in o to evaluate
upper_bound	index one past last item in o to evaluate

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

Reimplemented in IMP::container::MinimumQuadScore.

virtual double IMP::QuadScore::evaluate_indexes_delta	(	Model *	m,
		const ParticleIndexQuads &	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.

Reimplemented in IMP::container::MinimumQuadScore.

virtual double IMP::QuadScore::evaluate_indexes_scores	(	Model *	m,
		const ParticleIndexQuads &	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].

Reimplemented in IMP::container::MinimumQuadScore.

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

QuadScore.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Member Function Documentation