IMP::TripletModifier Class Reference

---

Detailed Description

A base class for modifiers of ParticleTriplets.

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

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

See also:

IMP::TripletFunctor

Implementors should see IMP_TRIPLET_MODIFIER() and IMP_TRIPLET_MODIFIER_DA().

Inheritance diagram for IMP::TripletModifier:

[legend]

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

---

Member Function Documentation

virtual void IMP::TripletModifier::apply	(	const ParticleTripletsTemp &	o,
		DerivativeAccumulator &	da
	)			const [virtual]

Apply the function to a collection of ParticleTriplets

virtual void IMP::TripletModifier::apply

(

const ParticleTripletsTemp &

o

)

const [virtual]

Apply the function to a collection of ParticleTriplets

virtual void IMP::TripletModifier::apply

(

const ParticleTriplet &

vt

)

const [virtual]

Apply the function to a single value

virtual void IMP::TripletModifier::apply	(	const ParticleTriplet &	vt,
		DerivativeAccumulator &	da
	)			const [virtual]

Apply the function to a single value

virtual ContainersTemp IMP::TripletModifier::get_input_containers

(

const ParticleTriplet &

vt

)

const [pure virtual]

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

virtual ParticlesTemp IMP::TripletModifier::get_input_particles

(

const ParticleTriplet &

vt

)

const [pure virtual]

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

virtual ParticlesList IMP::TripletModifier::get_interacting_particles

(

const ParticleTriplet &

vt

)

const [pure virtual]

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

virtual ContainersTemp IMP::TripletModifier::get_output_containers

(

const ParticleTriplet &

vt

)

const [pure virtual]

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

virtual ParticlesTemp IMP::TripletModifier::get_output_particles

(

const ParticleTriplet &

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:

• TripletModifier.h
• __init__.py