LatticeTester::Coordinates Class Reference

An object type that contains a set of coordinate indices, used to specify a projection. More...

Inheritance diagram for LatticeTester::Coordinates:

Public Member Functions
	Coordinates ()
	Constructs an empty set of coordinates.
	Coordinates (const Coordinates &other)
	Copy-constructor.
	Coordinates (const std::vector< std::size_t > &coord)
	Builds a set of coordinates by adding all the elements of coord in it.
template<typename InputIterator >
	Coordinates (InputIterator first, InputIterator last)
	Constructs a coordinate set populated with the values from first (inclusively) to last (exclusively).

Related Symbols
(Note that these are not member symbols.)
static std::ostream &	operator<< (std::ostream &os, const Coordinates &coords)
	Formats the coordinate set coords and outputs it to os.
static std::istream &	operator>> (std::istream &is, Coordinates &coords)
	Reads a formatted coordinate set from is.

Detailed Description

An object type that contains a set of coordinate indices, used to specify a projection.

This is a standard C++ set, std::set<std::size_t>, with additional input and output operators. These types of objects are created and returned by the classes in the CoordinateSets namespace. This class also offers some input and output operators. Important: The coordinates are assumed to start at 1.

Constructor & Destructor Documentation

Coordinates() [1/4]

LatticeTester::Coordinates::Coordinates ( )

inline

Constructs an empty set of coordinates.

Coordinates() [2/4]

LatticeTester::Coordinates::Coordinates ( const Coordinates & other )

inline

Copy-constructor.

Coordinates() [3/4]

LatticeTester::Coordinates::Coordinates ( const std::vector< std::size_t > & coord )

inline

Builds a set of coordinates by adding all the elements of coord in it.

Coordinates() [4/4]

template<typename InputIterator >

LatticeTester::Coordinates::Coordinates ( InputIterator first, InputIterator last )

inline

Constructs a coordinate set populated with the values from first (inclusively) to last (exclusively).

Friends And Related Symbol Documentation

operator<<()

static std::ostream & operator<< ( std::ostream & os, const Coordinates & coords )

related

Formats the coordinate set coords and outputs it to os.

operator>>()

static std::istream & operator>> ( std::istream & is, Coordinates & coords )

related

Reads a formatted coordinate set from is.

The input must consist of positive integers separated by whitespace and/or by commas, and optionally enclosed in braces. The ordering is not important. Repeated values are ignored. For example, the following strings are valid input that would produce equivalent Coordinates objects:

• 1 2 5
• 1, 2, 5
• {1 2 5}
• {1,2,5}
• {1, 2, 5}
• 2 5 1
• 2 1 5 1

---

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

• include/latticetester/Coordinates.h