A shared container for Quads. More...

#include <IMP/kernel/QuadContainer.h>

Inheritance diagram for IMP::kernel::QuadContainer:

Public Types
typedef ParticleIndexQuad	ContainedIndexType

typedef ParticleIndexQuads	ContainedIndexTypes

typedef ParticleQuad	ContainedType

typedef ParticleQuadsTemp	ContainedTypes

Public Member Functions
void	apply (const QuadModifier *sm) const
	Apply a SingletonModifier to the contents.

void	apply_generic (const QuadModifier *m) const
	Just use apply() in the base class.

bool	get_contains_particle_quad (ParticleQuad v) const
	This function is very slow and you should think hard about using it. More...

virtual ParticleIndexQuads	get_indexes () const =0

unsigned int	get_number_of_particle_quads () const

ParticleQuad	get_particle_quad (unsigned int i) const

ParticleQuadsTemp	get_particle_quads () const

virtual ParticleIndexQuads	get_range_indexes () const =0

Public Member Functions inherited from IMP::kernel::Container
virtual void	do_after_evaluate (DerivativeAccumulator *accpt)
	Reset changed status.

ModelObjectsTemp	do_get_outputs () const
	containers don't have outputs

virtual ParticleIndexes	get_all_possible_indexes () const =0
	Get contained particles. More...

ParticlesTemp	get_all_possible_particles () const

int	get_contents_version () const

bool	get_is_changed () const

virtual bool	get_is_decomposable () const

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

virtual VersionInfo	get_version_info () const
	Get information about the module and version of the object.

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)

virtual std::string	get_type_name () const

Protected Member Functions
	QuadContainer (kernel::Model *m, std::string name="QuadContainer %1%")

virtual void	do_apply (const QuadModifier *sm) const =0

virtual bool	do_get_provides_access () const

Protected Member Functions inherited from IMP::kernel::Container
	Container (kernel::Model *m, std::string name="Container %1%")

void	set_is_changed (bool tf)
	Call this with true when the contents of the container change. More...

Protected Member Functions inherited from IMP::kernel::ScoreState
virtual void	do_before_evaluate ()=0

Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemp	do_get_inputs () const =0

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

Stores a shared collection of Quads.

Definition at line 37 of file kernel/QuadContainer.h.

Member Function Documentation

bool IMP::kernel::QuadContainer::get_contains_particle_quad ( ParticleQuad v ) const

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. This is slow and dependent on the order of elements in the tuple.

Return whether the container has the given element.

virtual ParticleIndexQuads IMP::kernel::QuadContainer::get_indexes ( ) const

pure virtual

Get all the indexes contained in the container.

unsigned int IMP::kernel::QuadContainer::get_number_of_particle_quads ( ) const

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. This can be very slow and is probably not useful

ParticleQuad IMP::kernel::QuadContainer::get_particle_quad ( unsigned int i ) const

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP.Use get_indexes() instead and thing about using the IMP_CONTAINER_FOREACH() macro.

ParticleQuadsTemp IMP::kernel::QuadContainer::get_particle_quads ( ) const

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_indexes() instead.

virtual ParticleIndexQuads IMP::kernel::QuadContainer::get_range_indexes ( ) const

pure virtual

Get all the indexes that might possibly be contained in the container, useful with dynamic containers. For example, with a container::ClosePairContainer, this is the list of all pairs taken from input list (those that are far apart in addition to those that are close).

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

kernel/QuadContainer.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation