Apply a PairFunction to a Pair. More...

#include <IMP/core/PairConstraint.h>

Inheritance diagram for IMP::core::PairConstraint:

Public Member Functions
	PairConstraint (PairModifier before, PairDerivativeModifier after, const ParticlePair &vt, std::string name="PairConstraint %1%")

	PairConstraint (PairModifier before, PairDerivativeModifier after, kernel::Model *m, const ParticleIndexPair &vt, std::string name="PairConstraint %1%")

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::Constraint
	Constraint (kernel::Model *m, std::string name="Constraint %1%")

virtual void	do_after_evaluate (DerivativeAccumulator *da)

virtual void	do_before_evaluate ()

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

	ScoreState (kernel::Model *m)

	ScoreState (std::string name="ScoreState %1%")

void	after_evaluate (DerivativeAccumulator *accpt)
	Do post evaluation work if needed.

void	before_evaluate ()
	Force update of the structure.

ContainersTemp	get_input_containers () const

ParticlesTemp	get_input_particles () const

ContainersTemp	get_output_containers () const

ParticlesTemp	get_output_particles () const

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

	ModelObject (std::string name)

virtual void	do_set_model (kernel::Model *)

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

bool	get_is_part_of_model () 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)

virtual void	set_model (kernel::Model *m)

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
virtual kernel::ModelObjectsTemp	do_get_inputs () const

virtual kernel::ModelObjectsTemp	do_get_outputs () const

void	do_update_attributes ()

void	do_update_derivatives (DerivativeAccumulator *da)

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...

	Object ()

Detailed Description

The score state is passed up to two PairModifiers, one to apply before evaluation and the other after. The one after should take a DerivativeAccumulator as its last argument for PairModifier::apply() and will only be called if the score was computed with derivatives.

See Also: container::PairsConstraint

Definition at line 31 of file PairConstraint.h.

Constructor & Destructor Documentation

IMP::core::PairConstraint::PairConstraint	(	PairModifier *	before,
		PairDerivativeModifier *	after,
		const ParticlePair &	vt,
		std::string	name = `"PairConstraint %1%"`
	)

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the model/index constructor.

Definition at line 43 of file PairConstraint.h.

Member Function Documentation

virtual kernel::ModelObjectsTemp IMP::core::PairConstraint::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.

virtual kernel::ModelObjectsTemp IMP::core::PairConstraint::do_get_outputs ( ) const

protectedvirtual

Get any Particle, Container or other ModelObjects changed by this during evaluation. This is only useful for ScoreStates, at the moment.

Implements IMP::kernel::ModelObject.

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

PairConstraint.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation