IMP::QuadModifier Class Reference

---

Detailed Description

A base class for modifiers of ParticleQuads.

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

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

See also:

IMP::QuadFunctor

Implementors should see IMP_QUAD_MODIFIER() and IMP_QUAD_MODIFIER_DA().

Inheritance diagram for IMP::QuadModifier:

[legend]

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

---

Member Function Documentation

virtual void IMP::QuadModifier::apply	(	const ParticleQuadsTemp &	o,
		DerivativeAccumulator &	da
	)			const [virtual]

Apply the function to a collection of ParticleQuads

virtual void IMP::QuadModifier::apply

(

const ParticleQuadsTemp &

o

)

const [virtual]

Apply the function to a collection of ParticleQuads

virtual void IMP::QuadModifier::apply

(

const ParticleQuad &

vt

)

const [virtual]

Apply the function to a single value

virtual void IMP::QuadModifier::apply	(	const ParticleQuad &	vt,
		DerivativeAccumulator &	da
	)			const [virtual]

Apply the function to a single value

virtual ContainersTemp IMP::QuadModifier::get_input_containers

(

const ParticleQuad &

vt

)

const [pure virtual]

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

virtual ParticlesTemp IMP::QuadModifier::get_input_particles

(

const ParticleQuad &

vt

)

const [pure virtual]

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

virtual ParticlesList IMP::QuadModifier::get_interacting_particles

(

const ParticleQuad &

vt

)

const [pure virtual]

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

virtual ContainersTemp IMP::QuadModifier::get_output_containers

(

const ParticleQuad &

vt

)

const [pure virtual]

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

virtual ParticlesTemp IMP::QuadModifier::get_output_particles

(

const ParticleQuad &

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:

• QuadModifier.h
• __init__.py