A shared container for Pairs. More...

#include <IMP/kernel/PairContainer.h>

Inheritance diagram for IMP::kernel::PairContainer:

Public Types
typedef kernel::ParticleIndexPair	ContainedIndexType

typedef kernel::ParticleIndexPairs	ContainedIndexTypes

typedef kernel::ParticlePair	ContainedType

typedef kernel::ParticlePairsTemp	ContainedTypes

typedef PairModifier	Modifier

typedef const kernel::ParticleIndexPair &	PassContainedIndexType

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

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

const kernel::ParticleIndexPairs &	get_contents () const

virtual kernel::ParticleIndexPairs	get_indexes () const =0

unsigned int	get_number_of_particle_pairs () const

kernel::ParticlePair	get_particle_pair (unsigned int i) const

kernel::ParticlePairsTemp	get_particle_pairs () const

virtual kernel::ParticleIndexPairs	get_range_indexes () const =0

Public Member Functions inherited from IMP::kernel::Container
ModelObjectsTemp	do_get_outputs () const
	containers don't have outputs

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

std::size_t	get_contents_hash () const

virtual bool	get_is_decomposable () const

Public Member Functions inherited from IMP::kernel::ModelObject
	ModelObject (kernel::Model *m, std::string name)

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

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)

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
	PairContainer (kernel::Model *m, std::string name="PairContainer %1%")

virtual void	do_apply (const PairModifier *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%")

virtual std::size_t	do_get_contents_hash () const =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...

Detailed Description

Stores a shared collection of Pairs.

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

Member Function Documentation

virtual kernel::ParticleIndexPairs IMP::kernel::PairContainer::get_indexes ( ) const

pure virtual

Get all the indexes contained in the container.

This should be protected but isn't for compatibility reasons.

External callers should use get_contents().

Implemented in IMP::container::ExclusiveConsecutivePairContainer, IMP::container::ClosePairContainer, IMP::container::CloseBipartitePairContainer, IMP::container::ConsecutivePairContainer, IMP::container::ConnectingPairContainer, IMP::container::AllBipartitePairContainer, IMP::atom::BondPairContainer, and IMP::container::AllPairContainer.

unsigned int IMP::kernel::PairContainer::get_number_of_particle_pairs ( ) 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

kernel::ParticlePair IMP::kernel::PairContainer::get_particle_pair ( 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.

kernel::ParticlePairsTemp IMP::kernel::PairContainer::get_particle_pairs ( ) 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 kernel::ParticleIndexPairs IMP::kernel::PairContainer::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).

Implemented in IMP::container::ExclusiveConsecutivePairContainer, IMP::container::ClosePairContainer, IMP::container::CloseBipartitePairContainer, IMP::container::ConsecutivePairContainer, IMP::container::ConnectingPairContainer, IMP::container::AllBipartitePairContainer, IMP::atom::BondPairContainer, and IMP::container::AllPairContainer.

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

kernel/PairContainer.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation