LatticeTester::Lacunary< Int > Class Template Reference

REMOVE! More...

#include <latticetester/Lacunary.h>

Public Member Functions
	Lacunary (const IntVec &C, int64_t t)
	Constructor for a set of \(t\) indices given in the vector C.
	Lacunary (int64_t t=0)
	Constructor of an empty set of \(t\) lacunary indices.
	~Lacunary ()
	Destructor.
Int &	operator[] (int64_t i)
	Returns a reference to the value of m_lac[i].
Int &	getLac (int64_t i)
	Calling the object.getLac(i) gives the same result than calling object[i].
int64_t	getSize () const
	Returns the size of the set, that is the number of elements in the vector of indices.
bool	calcIndicesStreams (int64_t s, int64_t w, int64_t maxDim)
	Fills the values of this object with maxDim indices starting from 0 by groups of \(s\), spaced apart by \(2^w\).
std::string	toString () const
	Returns a string that describes this object.

Detailed Description

template<typename Int>
class LatticeTester::Lacunary< Int >

REMOVE!

This class represents a set of indices with lacunary values, usually with the values spaced in a certain systematic way (see calcIndicesStreams). It is typically used by subclasses of IntLatticeExt. The values of the lacunary indices are stored in a vector and can be accessed via the [] operator.

Remarks

As it is, this class could be replaced by a simple vector when it occurs. It does not implement any feature that a basic vector class does not have. This class was part of the legacy code base but removing the instances where it is used would take time ...

Constructor & Destructor Documentation

Lacunary() [1/2]

template<typename Int >

LatticeTester::Lacunary< Int >::Lacunary ( const IntVec & C, int64_t t )

inline

Constructor for a set of \(t\) indices given in the vector C.

Lacunary() [2/2]

template<typename Int >

LatticeTester::Lacunary< Int >::Lacunary ( int64_t t = 0 )

inlineexplicit

Constructor of an empty set of \(t\) lacunary indices.

This constructor set the value of the indices to 0. To set indices, one should use either one [] or getLac, or the calcIndicesStreams() method.

~Lacunary()

template<typename Int >

LatticeTester::Lacunary< Int >::~Lacunary ( )

inline

Destructor.

Member Function Documentation

calcIndicesStreams()

template<typename Int >

bool LatticeTester::Lacunary< Int >::calcIndicesStreams	(	int64_t	s,
		int64_t	w,
		int64_t	maxDim )

Fills the values of this object with maxDim indices starting from 0 by groups of \(s\), spaced apart by \(2^w\).

When \(w=0\), we have non-lacunary indices. Returns true in the lacunary case, and false otherwise.

getLac()

template<typename Int >

Int & LatticeTester::Lacunary< Int >::getLac ( int64_t i )

inline

Calling the object.getLac(i) gives the same result than calling object[i].

getSize()

template<typename Int >

int64_t LatticeTester::Lacunary< Int >::getSize ( ) const

inline

Returns the size of the set, that is the number of elements in the vector of indices.

operator[]()

template<typename Int >

Int & LatticeTester::Lacunary< Int >::operator[] ( int64_t i )

inline

Returns a reference to the value of m_lac[i].

(m_lac is the underlying vector storing the set of indices.)

toString()

template<typename Int >

std::string LatticeTester::Lacunary< Int >::toString

(

)

const

Returns a string that describes this object.

This string will contain the dimension and all the indices stored.

---

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

• include/latticetester/Lacunary.h