IMP::PairModifier Class Reference

---

Detailed Description

A base class for modifiers of ParticlePairs.

The primary function of such a class is to change the passed particles.

A given PairModifier may only work when passed a DerivativeAccumulator or when not passed one.

See also:

IMP::PairFunctor

Implementors should see IMP_PAIR_MODIFIER() and IMP_PAIR_MODIFIER_DA().

Inheritance diagram for IMP::PairModifier:

[legend]

Public Member Functions
def	__disown__
virtual void	apply (const ParticlePairsTemp &o, DerivativeAccumulator &da) const
virtual void	apply (const ParticlePairsTemp &o) const
virtual void	apply (const ParticlePair &vt) const
virtual void	apply (const ParticlePair &vt, DerivativeAccumulator &da) const
virtual ContainersTemp	get_input_containers (const ParticlePair &vt) const =0
virtual ParticlesTemp	get_input_particles (const ParticlePair &vt) const =0
virtual ParticlesList	get_interacting_particles (const ParticlePair &vt) const =0
virtual ContainersTemp	get_output_containers (const ParticlePair &vt) const =0
virtual ParticlesTemp	get_output_particles (const ParticlePair &vt) const =0
	PairModifier (std::string name="PairModifier %1%")

---

Member Function Documentation

virtual void IMP::PairModifier::apply	(	const ParticlePairsTemp &	o,
		DerivativeAccumulator &	da
	)			const [virtual]

Apply the function to a collection of ParticlePairs

virtual void IMP::PairModifier::apply

(

const ParticlePairsTemp &

o

)

const [virtual]

Apply the function to a collection of ParticlePairs

virtual void IMP::PairModifier::apply

(

const ParticlePair &

vt

)

const [virtual]

Apply the function to a single value

virtual void IMP::PairModifier::apply	(	const ParticlePair &	vt,
		DerivativeAccumulator &	da
	)			const [virtual]

Apply the function to a single value

virtual ContainersTemp IMP::PairModifier::get_input_containers

(

const ParticlePair &

vt

)

const [pure virtual]

Get the set of input containers when this modifier is applied to the arguments.

virtual ParticlesTemp IMP::PairModifier::get_input_particles

(

const ParticlePair &

vt

)

const [pure virtual]

Get the set of particles read when applied to the arguments.

virtual ParticlesList IMP::PairModifier::get_interacting_particles

(

const ParticlePair &

vt

)

const [pure virtual]

Get the set of interactions induced by applying to the argument.

virtual ContainersTemp IMP::PairModifier::get_output_containers

(

const ParticlePair &

vt

)

const [pure virtual]

Get the set of output containers when this modifier is applied to the arguments.

virtual ParticlesTemp IMP::PairModifier::get_output_particles

(

const ParticlePair &

vt

)

const [pure virtual]

Get the set of particles modifier when applied to the arguments.

---

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

• PairModifier.h
• __init__.py