CyclicIndex Class Reference

A class for a cyclic index. More...

#include <CyclicIndex.h>

List of all members.

Public Member Functions
Constructors etc.
	CyclicIndex (const int n)
	Constructor. Initialize index to zero.
	CyclicIndex (const CyclicIndex &other)
	Copy constructor.
CyclicIndex &	operator= (const CyclicIndex &other)
	Assignment operator.
	~CyclicIndex ()
	Trivial destructor.
Accesors.
int	operator() () const
	Return the index.
Manipulators.
void	set (int i)
	Set the index to i mod N.
Friends
CyclicIndex &	operator++ (CyclicIndex &ci)
	Increment the index.
CyclicIndex &	operator-- (CyclicIndex &ci)
	Decrement the index.

---

Detailed Description

A class for a cyclic index.

---

Friends And Related Function Documentation

CyclicIndex & operator++

(

CyclicIndex &

ci

)

[friend]

Increment the index.

CyclicIndex & operator--

(

CyclicIndex &

ci

)

[friend]

Decrement the index.

---

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

• CyclicIndex.h