The BTK AtomIterator Concept

Description:

An AtomIterator is an STL BidirectionalIterator (1) whose value_type (2) is a model of the Atom Concept.

Concept Refines:

STL Concepts:

BidirectionalIterator

Associated Types:

The same as for an STL BidirectionalIterator.

Valid Expressions:

The same as for an STL BidirectionalIterator.

Models:

• BTK::MOLECULES::AtomicStructure::atom_iterator
• BTK::MOLECULES::Chain::atom_iterator
• BTK::MOLECULES::Molecule::atom_iterator
• BTK::MOLECULES::Polymer::atom_iterator
• BTK::MOLECULES::System::atom_iterator (if defined)

Notes:

• The AtomIterator is defined as a BidirectionalIterator (as opposed to a RandomAccessIterator) because the BTK supports the use of containers that are not STL RandomAccessContainers for atom storage (e.g. std::list).
• All AtomIterator objects are expected to work with the std::iterator_traits<> template.

---