Lattice Tester Guide  1.0-9
Software Package For Testing The Uniformity Of Integral Lattices In The Real Space
LatticeTester::Coordinates Class Reference

This is basically a std::set<std::size_t>. More...

#include <latticetester/Coordinates.h>

Inherits std::set< K >.

Public Member Functions

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

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const Coordinates &coords)
 
std::istream & operator>> (std::istream &is, Coordinates &coords)
 

Detailed Description

This is basically a std::set<std::size_t>.

It also implements an output and an input operator, but it is useless to have a class for that. This class is used to store the vector of coordinates used when computing the projections with lacunary indices. Objects of this class are created and returned by the classes in the CoordinateSets namespace.

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 Function Documentation

◆ operator<<()

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

Formats the coordinate set coords and outputs it to os.

◆ operator>>()

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: