Detailed Description

Exclude particles from the given range of z coordinates.

Definition at line 18 of file ExcludeZRangeSingletonScore.h.

Public Member Functions
	ExcludeZRangeSingletonScore (double bottom, double top, double k)

virtual ModelObjectsTemp	do_get_inputs (Model *m, const ParticleIndexes &pis) const
	Overload this method to specify the inputs. More...

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

double	evaluate_indexes_delta (Model m, const ParticleIndexes &p, 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...

double	evaluate_indexes_scores (Model m, const ParticleIndexes &p, 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...

double	get_bottom_z () const

double	get_k () const

double	get_top_z () const

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

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

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

IMP::npctransport::ExcludeZRangeSingletonScore::ExcludeZRangeSingletonScore	(	double	bottom,
		double	top,
		double	k
	)

Exclude particles from the range of z coordinates [bottom_..top_] with repulsive force constant k

Member Function Documentation

virtual ModelObjectsTemp IMP::npctransport::ExcludeZRangeSingletonScore::do_get_inputs	(	Model *	m,
		const ParticleIndexes &	pis
	)		const

virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

double IMP::npctransport::ExcludeZRangeSingletonScore::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 45 of file ExcludeZRangeSingletonScore.h.

virtual double IMP::npctransport::ExcludeZRangeSingletonScore::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.

double IMP::npctransport::ExcludeZRangeSingletonScore::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 one past 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 45 of file ExcludeZRangeSingletonScore.h.

double IMP::npctransport::ExcludeZRangeSingletonScore::evaluate_indexes_delta	(	Model *	m,
		const ParticleIndexes &	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 from IMP::SingletonScore.

Definition at line 45 of file ExcludeZRangeSingletonScore.h.

double IMP::npctransport::ExcludeZRangeSingletonScore::evaluate_indexes_scores	(	Model *	m,
		const ParticleIndexes &	o,
		DerivativeAccumulator *	da,
		unsigned int	lower_bound,
		unsigned int	upper_bound,
		std::vector< double > &	score
	)		const