IMP logo
IMP Reference Guide  2.7.0
The Integrative Modeling Platform
IMP::container::ExclusiveConsecutivePairContainer Class Reference

#include <IMP/container/ConsecutivePairContainer.h>

+ Inheritance diagram for IMP::container::ExclusiveConsecutivePairContainer:

Detailed Description

This is an ConsecutivePairContainer where each particle can only be on one ExclusiveConsecutivePairContainer. The exclusivity makes the code more efficient and allows one to use the ExclusiveConsecutivePairFilter, which is way more efficient than using an InContainerPairFilter with a ConsecutivePairContainer.

Definition at line 104 of file ConsecutivePairContainer.h.

Public Member Functions

 ExclusiveConsecutivePairContainer (Model *m, const ParticleIndexes &ps, std::string name="ExclusiveConsecutivePairContainer%1%")
template<class F >
void apply_generic (F *f) const
 apply to each item in container More...
void do_apply (const PairModifier *sm) const
virtual ModelObjectsTemp do_get_inputs () const
virtual ParticleIndexes get_all_possible_indexes () const
 Get contained particles. More...
virtual ParticleIndexPairs get_indexes () const
virtual ParticleIndexPairs get_range_indexes () const
virtual std::string get_type_name () const
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
- Public Member Functions inherited from IMP::PairContainer
void apply (const PairModifier *sm) const
 Apply a SingletonModifier to the contents. More...
void apply_generic (const PairModifier *m) const
 Just use apply() in the base class. More...
const ParticleIndexPairsget_contents () const
ParticlePair get_particle_pair (unsigned int i) const
ParticlePairsTemp get_particle_pairs () const
- Public Member Functions inherited from IMP::Container
ModelObjectsTemp do_get_outputs () const
 containers don't have outputs More...
std::size_t get_contents_hash () const
virtual bool get_is_decomposable () const
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
bool get_has_required_score_states () const
 Return whether score states are computed. More...
ModelObjectsTemp get_inputs () const
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
Modelget_model () const
ModelObjectsTemp get_outputs () const
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
CheckLevel get_check_level () const
LogLevel get_log_level () const
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)

Protected Member Functions

virtual void do_destroy ()
virtual std::size_t do_get_contents_hash () const
- Protected Member Functions inherited from IMP::PairContainer
 PairContainer (Model *m, std::string name="PairContainer %1%")
virtual bool do_get_provides_access () const
- Protected Member Functions inherited from IMP::Container
 Container (Model *m, std::string name="Container %1%")
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
virtual void handle_set_has_required_score_states (bool)
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...

Additional Inherited Members

- Public Types inherited from IMP::PairContainer
typedef ParticleIndexPair ContainedIndexType
typedef ParticleIndexPairs ContainedIndexTypes
typedef ParticlePair ContainedType
typedef ParticlePairsTemp ContainedTypes
typedef PairModifier Modifier
typedef const ParticleIndexPairPassContainedIndexType

Member Function Documentation

template<class F >
void IMP::container::ExclusiveConsecutivePairContainer::apply_generic ( F *  f) const

apply to each item in container

Definition at line 148 of file ConsecutivePairContainer.h.

virtual void IMP::container::ExclusiveConsecutivePairContainer::do_destroy ( )

Called by Object destructor - removes all keys associated with the exclusive consecutive pair container, so it can be now added to another exclusive consecutive pair container

Reimplemented from IMP::Object.

virtual ModelObjectsTemp IMP::container::ExclusiveConsecutivePairContainer::do_get_inputs ( ) const

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::ModelObject.

virtual ParticleIndexes IMP::container::ExclusiveConsecutivePairContainer::get_all_possible_indexes ( ) const

Get contained particles.

Get a list of all particles contained in this one, given that the input containers are up to date.

Implements IMP::Container.

virtual ParticleIndexPairs IMP::container::ExclusiveConsecutivePairContainer::get_indexes ( ) const

Get all the indexes contained in the container.

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

External callers should use get_contents().

Implements IMP::PairContainer.

virtual ParticleIndexPairs IMP::container::ExclusiveConsecutivePairContainer::get_range_indexes ( ) const

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).

Implements IMP::PairContainer.

virtual ::IMP::VersionInfo IMP::container::ExclusiveConsecutivePairContainer::get_version_info ( ) const

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 164 of file ConsecutivePairContainer.h.

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