IMP::core::GenericAttributeSingletonScore< UF > Class Template Reference

Apply a function to an attribute. More...

#include <IMP/core/AttributeSingletonScore.h>

Inheritance diagram for IMP::core::GenericAttributeSingletonScore< UF >:

Detailed Description

template<class UF>
class IMP::core::GenericAttributeSingletonScore< UF >

Apply a function to an attribute.

This Score scores a particle by passing an attribute value directly to a unary function.

Definition at line 24 of file AttributeSingletonScore.h.

Public Member Functions
	GenericAttributeSingletonScore (UnaryFunction *f, FloatKey k)
	Apply function f to attribute k. More...
virtual ModelObjectsTemp	do_get_inputs (Model *m, const ParticleIndexes &pis) const
double	evaluate_if_good_indexes (Model *m, const ParticleIndexes &p, DerivativeAccumulator *da, double max, unsigned int lower_bound, unsigned int upper_bound) const
virtual double	evaluate_index (Model *m, ParticleIndex p, DerivativeAccumulator *da) const
	Compute the score and the derivative if needed. More...
double	evaluate_indexes (Model *m, const ParticleIndexes &p, DerivativeAccumulator *da, unsigned int lower_bound, unsigned int upper_bound) const
	Compute the score and the derivative if needed over a set. 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...
Public Member Functions inherited from IMP::SingletonScore
	SingletonScore (std::string name="SingletonScore %1%")
Restraints	create_current_decomposition (Model *m, ParticleIndex vt) const
	Decompose this pair score acting on the pair into a set of restraints. More...
virtual double	evaluate_if_good_index (Model *m, ParticleIndex vt, DerivativeAccumulator *da, double max) const
	Compute the score and the derivative if needed, only if "good". More...
Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp	get_inputs (Model *m, const ParticleIndexes &pis) const
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::SingletonScore
typedef Particle *	Argument
typedef ParticleIndex	IndexArgument
typedef SingletonModifier	Modifier
typedef Particle *	PassArgument
typedef ParticleIndex	PassIndexArgument
Protected Member Functions inherited from IMP::SingletonScore
virtual Restraints	do_create_current_decomposition (Model *m, ParticleIndex vt) const
	Overide 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

template<class UF>

IMP::core::GenericAttributeSingletonScore< UF >::GenericAttributeSingletonScore	(	UnaryFunction *	f,
		FloatKey	k
	)

Apply function f to attribute k.

Member Function Documentation

template<class UF>

virtual ModelObjectsTemp IMP::core::GenericAttributeSingletonScore< UF >::do_get_inputs ( Model *  m, const ParticleIndexes &  pis  ) const

virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

Definition at line 33 of file AttributeSingletonScore.h.

Here is the call graph for this function:

template<class UF>

double IMP::core::GenericAttributeSingletonScore< UF >::evaluate_if_good_indexes ( Model *  m, const ParticleIndexes &  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_SINGLETON_SCORE() macro.

Reimplemented from IMP::SingletonScore.

Definition at line 37 of file AttributeSingletonScore.h.

template<class UF>

virtual double IMP::core::GenericAttributeSingletonScore< UF >::evaluate_index ( Model *  m, ParticleIndex  vt, DerivativeAccumulator *  da  ) const

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 Particle
da	a DerivativeAccumulator that weights computed derivatives. If nullptr, derivatives will not be computed.

Implements IMP::SingletonScore.

template<class UF>

double IMP::core::GenericAttributeSingletonScore< UF >::evaluate_indexes ( Model *  m, const ParticleIndexes &  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 Particle, 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 of last item in o to evaluate

Note

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

Reimplemented from IMP::SingletonScore.

Definition at line 37 of file AttributeSingletonScore.h.

template<class UF>

virtual ::IMP::VersionInfo IMP::core::GenericAttributeSingletonScore< UF >::get_version_info ( ) const

virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 38 of file AttributeSingletonScore.h.

---

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

• AttributeSingletonScore.h