IMP  2.4.0
The Integrative Modeling Platform
Public Member Functions | Protected Member Functions | List of all members
IMP::kernel::Container Class Referenceabstract

Abstract class for containers of particles. More...

#include <IMP/kernel/container_base.h>

+ Inheritance diagram for IMP::kernel::Container:

Detailed Description

Abstract class for containers of particles.

Containers store sets of tuples of particles. The degree of the tuple (i.e. whether each tuple contains one, two, three or four particles) is constant for each container. That is, a SingletonContainer is a set of single particles, a PairContainer is a set of pairs of particles etc.

These sets can come from a variety of sources, such as

Most basically, containers allow you to get their contents (eg SingletonContainer::get_indexes()) or do an operation on their contents IMP_CONTAINER_FOREACH().

Containers store sets and so are fundamentally unordered.

Definition at line 44 of file kernel/container_base.h.

Public Member Functions

ModelObjectsTemp do_get_outputs () const
 containers don't have outputs More...
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. 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::base::Object
virtual void clear_caches ()
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. More...
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

 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...
virtual void do_destroy ()

Member Function Documentation

ModelObjectsTemp IMP::kernel::Container::do_get_outputs ( ) const

containers don't have outputs

Implements IMP::kernel::ModelObject.

Definition at line 67 of file kernel/container_base.h.

virtual ParticleIndexes IMP::kernel::Container::get_all_possible_indexes ( ) const
pure virtual
std::size_t IMP::kernel::Container::get_contents_hash ( ) const

Return a hash that can be used to detect when the contents of the container changed. Store the value and then compare against the version next time to detect if it is different.

Definition at line 64 of file kernel/container_base.h.

virtual bool IMP::kernel::Container::get_is_decomposable ( ) const

True if the container's contents are not independent from one another, and so it cannot be decomposed into a sum of terms. Examples include connectivity.

Definition at line 74 of file kernel/container_base.h.

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