The BTK AtomicStructure Concept

Description:

An object that models an immutable atomic structure (i.e. a structure that does not support the insertion or deletion of atoms).

Concept Refines:

STL Concepts:

• ReversibleContainer

BTK Concepts:

• AtomIterable
• StrictlyChemicallyTyped

Notation:

X -- A type that models the AtomicStructure Concept
x -- An object of type X

Associated Types:

In addition to the types required by the refined concepts:

Atom Type

X::atom_type

A type that models the Atom Concept

Definitions:

None.

Valid Expressions:

In addition to those expressions specified by the refined concepts, the following expressions must be valid:

Expression	Type Requirements	Precondition	Semantics	Postcondition	Complexity
X::const_reference x.operator[](X::size_type n) const		n is in the range [0,x.size())	Gets a constant reference to the n'th atom in the structure.
std::ostream & x.print(std::ostream & s) const			Writes the contents of x to stream s.
std::ostream & x.print(std::ostream & s, size_type n) const			Writes the contents of x to stream, using n as the first atom number.

Models:

• BTK::MOLECULES::AtomicStructure
• BTK::MOLECULES::Chain
• BTK::MOLECULES::Molecule
• BTK::MOLECULES::Monomer

---