PUBLIC

IndexNdC::IndexNdC(void) IndexNdC::IndexNdC(SizeT) IndexNdC::IndexNdC(IndexT *,SizeT) IndexNdC::IndexNdC(const IndexNdC &) IndexNdC::operator==(const IndexNdC &) const IndexNdC::operator!=(const IndexNdC &) const IndexNdC::operator+=(const IndexNdC &) IndexNdC::operator-=(const IndexNdC &) IndexNdC::operator*=(const IndexNdC &) IndexNdC::operator/=(const IndexNdC &) IndexNdC::operator+(const IndexNdC &) const IndexNdC::operator-(const IndexNdC &) const IndexNdC::operator*(const IndexNdC &) const IndexNdC::operator/(const IndexNdC &) const IndexNdC::operator*(const IntT) const IndexNdC::operator*(const RealT) const IndexNdC::operator/(const IntT) const IndexNdC::operator/(const RealT) const IndexNdC::Hash(void) const IndexNdC::Dim(void) const SArray1dC::Copy(void) const SArray1dC::operator=(const SArray1dC &) SArray1dC::SArray1d(void) const SArray1dC::SArray1d(void) SArray1dC::Enlarge(const IntT) const SArray1dC::Append(const SArray1dC &) SArray1dC::Join(const SArray1dC &) const SArray1dC::DebugAddresses(void) const SArray1dC::RefCounter(void) const SArray1dC::Buffer(void) SArray1dC::Buffer(void) const SArray1dC::DataStart(void) const SizeBufferAccessC::operator=(DataC *) SizeBufferAccessC::ReferenceElm(void) const SizeBufferAccessC::ReferenceVoid(void) const SizeBufferAccessC::Access(void) const SizeBufferAccessC::DataStart(void) const SizeBufferAccessC::N(void) const SizeBufferAccessC::Size(void) const SizeBufferAccessC::Limits(void) const SizeBufferAccessC::Range(void) const SizeBufferAccessC::IMin(void) const SizeBufferAccessC::IMax(void) const SizeBufferAccessC::operator[](const IndexT) const SizeBufferAccessC::operator[](const IndexT) SizeBufferAccessC::SAccess(void) const SizeBufferAccessC::IsEmpty(void) const SizeBufferAccessC::Contains(const IndexT) const SizeBufferAccessC::ShrinkHigh(const SizeT) SizeBufferAccessC::Swap(SizeBufferAccessC &) SizeBufferAccessC::Attach(const SizeBufferAccessC &) SizeBufferAccessC::Attach(const BufferAccessC &,const SizeT) SizeBufferAccessC::operator+(const SizeT) const SizeBufferAccessC::Fill(const DataC &) SizeBufferAccessC::CopyFrom(const SizeBufferAccessC &) SizeBufferAccessC::Copy(void) const

IndexNdC
N-dimensional index
include	"amma/IndexNd.hh"
User Level:	Default
Library:	Mgrid
Example:	exBuffer.cc
Section:	Basic Types.Indexing
In Scope:	std

Comments:
Class IndexNdC represents index of N-dimensional object.

public SArray1dC<class DataC>

IndexNdC()

Empty array

IndexNdC(SizeT dim)

A non-initialized array with the range <0, 'dim'-1>.

IndexNdC(IndexT * data,SizeT dim)

An array is created from the memory location 'data' with the range of access in <0, 'dim'-1>. 'data' is not deallocated during destruction of the array.

IndexNdC(const IndexNdC & nd)

Another access to the array 'ND'.

BooleanT operator==(const IndexNdC & index) const

Returns TRUE if indexes have the same values.

BooleanT operator!=(const IndexNdC & index) const

Returns TRUE if indexes have different values. Arithmetic operation on N-D index ---------------------------------

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

Adds 'ind' to this index'.

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

Subtracts index 'ind' from this index.

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

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

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

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

IndexNdC operator+(const IndexNdC & ind) const

Adds this index and 'ind'.

IndexNdC operator-(const IndexNdC & ind) const

Subtract index 'ind' from this index.

IndexNdC operator*(const IndexNdC & ind) const

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

IndexNdC operator/(const IndexNdC & ind) const

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

IndexNdC operator*(const IntT alpha) const

Multiplies this index by number 'alpha'.

IndexNdC operator*(const RealT alpha) const

Multiplies this index by real number 'alpha'.

IndexNdC operator/(const IntT alpha) const

Divides this index by number 'alpha'.

IndexNdC operator/(const RealT alpha) const

Divides this index by real number 'alpha'.

UIntT Hash(void) const

Return an almost unqiue hash value for this index.

SizeT Dim(void) const

number of items in the vector

SArray1dC<IndexC> Copy() const

Creates a new physical copy of the array.

const SArray1dC<IndexC> & operator=(const SArray1dC<IndexC> & vv)

Assigment, as for a BIG_OBJECT. Access to the object and its parts. -----------------------------------

const SArray1dC<IndexC> & SArray1d() const

Access to the whole constant array.

SArray1dC<IndexC> & SArray1d()

Access to the whole array. Modifications of the representation -----------------------------------

SArray1dC<IndexC> Enlarge(const IntT factor = 2) const

Enlarges the array by item duplications. Every item is duplicated 'factor' times. The return array is extended by adding of higher indexes.

SArray1dC<IndexC> & Append(const SArray1dC<IndexC> & a)

This array is extended by the length of the array 'a' and the contents of both arrays are copied to it. The function supports empty arrays.

SArray1dC<IndexC> Join(const SArray1dC<IndexC> & Oth) const

Join this Array and another into a new Array which is returned. This does not change either of its arguments. This is placed in the array first, followed by 'Oth'. Special operations ------------------

void DebugAddresses() const

Prints addresses into 'cerrAMMA'.

const BodyRefCounterC & RefCounter() const

Returns access to reference counter.

BufferRC<IndexC> & Buffer()

Access base data buffer.
Experts only.

const BufferRC<IndexC> & Buffer() const

Constant access base data buffer.
Experts only.

IndexC * DataStart() const

Returns the address of the first item if exists.

const SizeBufferAccessC<IndexC> & operator=(IndexC * bp)

Changes the reference element to the element pointed by 'bp'. Access to the object --------------------

IndexC * ReferenceElm(void) const

Returns the pointer to the reference element of the attached buffer. The reference element need not to be the valid element of the buffer.

void * ReferenceVoid(void) const

Returns the pointer to the reference element of the attached buffer. The reference element need not to be the valid element of the buffer. The function is intended to be used in printing.

const BufferAccessC<IndexC> & Access(void) const

Returns this object.

IndexC * DataStart() const

Returns the address of the first element of the buffer.

SizeT N() const

Returns the number of elements of the array.

SizeT Size() const

Returns the number of elements of the array.

const BufferSizeC & Limits() const

Returns the usable range of indeces expressed by this object.

const BufferSizeC & Range() const

Returns the usable range of indeces expressed by this object.

IndexT IMin() const

Returns the minimum index of the range of this access.

IndexT IMax() const

Returns the maximum index of the range of this access.

const IndexC & operator[](const IndexT i) const

Read-only access to the ('i'+1)-th element of the buffer.

IndexC & operator[](const IndexT i)

Read-write access to the ('i'+1)-th element of the buffer.

const SizeBufferAccessC<IndexC> & SAccess(void) const

Returns this object. Logical functions -----------------

BooleanT IsEmpty() const

Returns TRUE if the size of the array is zero.

BooleanT Contains(const IndexT i) const

Returns TRUE if the array contains an item with the index 'i'. Modifications of the access ---------------------------

const BufferSizeC & ShrinkHigh(const SizeT k)

Changes the number of elements by subtracting the last 'k' elements.

const SizeBufferAccessC<IndexC> & Swap(SizeBufferAccessC<IndexC> & a)

Exchanges the contents of this buffer with buffer 'a'.

void Attach(const SizeBufferAccessC<IndexC> & b)

Changes this buffer access to have the same access rights as 'b'.

void Attach(const BufferAccessC<IndexC> & b,const SizeT size)

Changes this buffer access to have the access rights as 'b' limited for 'size' elements.

SizeBufferAccessC<IndexC> operator+(const SizeT i) const

Creates the new access object shifted 'i' elements to the right (towards next elements). The size is descreased to fit the the original range of this access. Modifications of the buffer contents ------------------------------------

void Fill(const IndexC & d)

'd' value is assigned to all elements of the buffer.

void CopyFrom(const SizeBufferAccessC<IndexC> & oth)

Copy contents of another buffer into this one.
NB. Buffers MUST be the same length.

SizeBufferAccessC<IndexC> Copy(void) const

Returns a physical copy of this access pointing to the physical copy of the accessed buffer in the range accessible by this access. The new copy is necessary to attach to reference counted buffer or to delete at the end of the life of this object.