PUBLIC

Index3dC::Index3dC(SizeT) Index3dC::Index3dC(IndexT,IndexT,IndexT) Index3dC::Index3dC(RealT,RealT,RealT) Index3dC::Index3dC(const Index3dC &) Index3dC::operator==(const Index3dC &) const Index3dC::operator!=(const Index3dC &) const Index3dC::Set(IndexT,IndexT,IndexT) Index3dC::Set(const Index3dC &) Index3dC::I(void) const Index3dC::J(void) const Index3dC::K(void) const Index3dC::I(void) Index3dC::J(void) Index3dC::K(void) Index3dC::operator[](IndexT) const Index3dC::operator[](IndexT) Index3dC::Right(void) Index3dC::Left(void) Index3dC::Up(void) Index3dC::Down(void) Index3dC::RightN(void) const Index3dC::LeftN(void) const Index3dC::UpN(void) const Index3dC::DownN(void) const Index3dC::operator+=(const Index3dC &) Index3dC::operator-=(const Index3dC &) Index3dC::operator*=(const Index3dC &) Index3dC::operator/=(const Index3dC &) Index3dC::operator+(const Index3dC &) const Index3dC::operator-(const Index3dC &) const Index3dC::operator*(const Index3dC &) const Index3dC::operator/(const Index3dC &) const Index3dC::operator*(const IntT) const Index3dC::operator*(const RealT) const Index3dC::operator/(const IntT) const Index3dC::operator/(const RealT) const Index3dC::Hash(void) const Index3dC::Dim(void) const

Index3dC
Index of a 3-D array
include	"amma/Index3d.hh"
User Level:	Default
Library:	Mgrid
Example:	exBuffer.cc
Section:	Containers.Arrays.3-D Arrays Basic Types.Indexing
In Scope:	std

Comments:
The class Index3dC is a triple of integer values. It is usually used as a three dimensional index of three dimensional arrays.

SMALL OBJECT.

explicit Index3dC(SizeT dim)

Creates an index
This is for compatibilty with N-D indexes, which need to be told there dimentionality.

Index3dC(IndexT i = 0,IndexT j = 0,IndexT k = 0)

Creates index .

Index3dC(RealT ir,RealT jr,RealT kr)

Creates index where i,j,k are cut value of ir, jr, kr respectivily.

Index3dC(const Index3dC & index)

Copy constructor.

BooleanT operator==(const Index3dC & index) const

Returns TRUE if indexes have the same values.

BooleanT operator!=(const Index3dC & index) const

Returns TRUE if indexes have different values.

void Set(IndexT i,IndexT j,IndexT k)

Sets this index to be .

void Set(const Index3dC & index)

Sets this index to be equal to 'index'. Access to the member items --------------------------

IndexT I() const

Returns the first index.

IndexT J() const

Returns the second index.

IndexT K() const

Returns the third index.

IndexT & I()

Access to the first index.

IndexT & J()

Access to the second index.

IndexT & K()

Access to the third index.

IndexT operator[](IndexT i) const

Returns the i-th index.

IndexT & operator[](IndexT i)

Access to the i-th index. Access to the neighbouring 3D indexes -------------------------------------

Index3dC & Right()

Shifts the index to the right.

Index3dC & Left()

Shifts the index to the left.

Index3dC & Up()

Shifts the index to the up.

Index3dC & Down()

Shifts the index to the down.

Index3dC RightN() const

Returns the index of the right neighbour.

Index3dC LeftN() const

Returns the index of the left neighbour.

Index3dC UpN() const

Returns the index of the upper neighbour.

Index3dC DownN() const

Returns the index of the down neighbour. Arithmetic operations ---------------------

const Index3dC & operator+=(const Index3dC & ind)

Adds 'ind' to this index'.

const Index3dC & operator-=(const Index3dC & ind)

Subtract index 'ind' from this index.

const Index3dC & operator*=(const Index3dC & ind)

Multiplies this index by index 'ind' item by item.

const Index3dC & operator/=(const Index3dC & ind)

Divides this index by index 'ind' item by item.

Index3dC operator+(const Index3dC & ind) const

Adds this index and 'ind'.

Index3dC operator-(const Index3dC & ind) const

Subtract index 'ind' from this index.

Index3dC operator*(const Index3dC & ind) const

Returns this index multiplied by index 'ind' item by item.

Index3dC operator/(const Index3dC & ind) const

Returns this index divided by index 'ind' item by item.

Index3dC operator*(const IntT alpha) const

Multiplies this index by number 'alpha'.

Index3dC operator*(const RealT alpha) const

Multiplies this index by real number 'alpha'.

Index3dC operator/(const IntT alpha) const

Divides this index by number 'alpha'.

Index3dC operator/(const RealT alpha) const

Divides this index by real number 'alpha'. Special member functions ------------------------

UIntT Hash(void) const

Generates a randomised hash value for this index.

SizeT Dim(void) const

Returns a number of dimensions indexed.