Applies a SingletonScore to a Singleton. More...

#include <IMP/core/SingletonRestraint.h>

Inheritance diagram for IMP::core::SingletonRestraint:

Public Member Functions
	SingletonRestraint (SingletonScore ss, kernel::Particle vt, std::string name="SingletonRestraint %1%")
	Create the restraint. More...

	SingletonRestraint (kernel::Model m, SingletonScore ss, kernel::ParticleIndex vt, std::string name="SingletonRestraint %1%")
	Create the restraint. More...

virtual std::string	get_type_name () const

virtual ::IMP::base::VersionInfo	get_version_info () const
	Get information about the module and version of the object.

Public Member Functions inherited from IMP::kernel::Restraint
	Restraint (kernel::Model *m, std::string name)

void	add_score_and_derivatives (ScoreAccumulator sa) const

Restraint *	create_current_decomposition () const
	Decompose this restraint into constituent terms for the current conf. More...

Restraint *	create_decomposition () const
	Decompose this restraint into constituent terms. More...

virtual ScoringFunction *	create_scoring_function (double weight=1.0, double max=NO_MAX) const

virtual double	get_last_score () const

double	get_score () const

bool	get_was_good () const

void	set_weight (Float weight)

Float	get_weight () const

double	get_maximum_score () const

void	set_maximum_score (double s)

Public Member Functions inherited from IMP::kernel::ModelObject
	ModelObject (kernel::Model *m, std::string name)

bool	get_has_dependencies () const
	Return whether this object has dependencies computed.

bool	get_has_required_score_states () const

ModelObjectsTemp	get_inputs () const

ModelObjectsTemps	get_interactions () const

Model *	get_model () const

ModelObjectsTemp	get_outputs () const

const ScoreStatesTemp &	get_required_score_states () const

void	set_has_dependencies (bool tf)

void	set_has_required_score_states (bool tf)

Public Member Functions inherited from IMP::base::Object
virtual void	clear_caches ()

virtual void	do_destroy ()

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)

Protected Member Functions
IMP::kernel::ModelObjectsTemp	do_get_inputs () const

double	unprotected_evaluate (IMP::DerivativeAccumulator *accum) const

Protected Member Functions inherited from IMP::kernel::Restraint
virtual void	do_add_score_and_derivatives (ScoreAccumulator sa) const

virtual Restraints	do_create_current_decomposition () const

virtual Restraints	do_create_decomposition () const

ModelObjectsTemp	do_get_outputs () const

Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps	do_get_interactions () const

virtual void	handle_set_has_required_score_states (bool)

Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...

Detailed Description

This restraint stores a Singleton.

See Also: SingletonRestraint

Definition at line 29 of file SingletonRestraint.h.

Constructor & Destructor Documentation

IMP::core::SingletonRestraint::SingletonRestraint	(	SingletonScore *	ss,
		kernel::Particle *	vt,
		std::string	name = `"SingletonRestraint %1%"`
	)

This function takes the function to apply to the stored Singleton and the Singleton.

Definition at line 41 of file SingletonRestraint.h.

IMP::core::SingletonRestraint::SingletonRestraint	(	kernel::Model *	m,
		SingletonScore *	ss,
		kernel::ParticleIndex	vt,
		std::string	name = `"SingletonRestraint %1%"`
	)

This function takes the function to apply to the stored Singleton and the Singleton.

Definition at line 51 of file SingletonRestraint.h.

Member Function Documentation

IMP::kernel::ModelObjectsTemp IMP::core::SingletonRestraint::do_get_inputs ( ) const

protectedvirtual

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::kernel::ModelObject.

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

SingletonRestraint.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation