IMP::Container Class Reference

---

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

• user-provided lists, e.g. IMP::core::ListSingletonContainer
• operations on other containers e.g. IMP::core::PairContainerSet
• computations based on particle attributes e.g. IMP::Core::ClosePairContainer

Containers provide a variety of methods to

• get the number of tuples
• get the ith tuple
• iterate through the tuples
• determine if a tuple is contained in the set

Note:

Containers store sets and so are fundamentally unordered.

Inheritance diagram for IMP::Container:

[legend]

Public Member Functions
	Container (std::string name="Container %1%")
virtual ParticlesTemp	get_contained_particles () const =0
	Get contained particles.
virtual bool	get_contained_particles_changed () const =0
	Get whether the set of particles changed since last evaluation.
virtual ContainersTemp	get_input_containers () const =0
	Get the set of containers read by this one.
Friends
template<class T >
void	IMP::internal::unref (T *)

---

Member Function Documentation

virtual ParticlesTemp IMP::Container::get_contained_particles

(

)

const [pure virtual]

Get contained particles.

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

---

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

• container_base.h
• __init__.py