PUBLIC

BufferSizeC::BufferSizeC(SizeT) BufferSizeC::BufferSizeC(const BufferSizeC &) BufferSizeC::operator=(const BufferSizeC &) BufferSizeC::N(void) const BufferSizeC::Size(void) const BufferSizeC::Min(void) const BufferSizeC::Max(void) const BufferSizeC::Limits(void) const BufferSizeC::IsEmpty(void) const BufferSizeC::Contains(const IndexT) const BufferSizeC::In(const BufferSizeC &) const BufferSizeC::ShrinkHigh(const SizeT) BufferSizeC::ShrinkLow(const SizeT) BufferSizeC::Shrink(const SizeT) BufferSizeC::Swap(BufferSizeC &)

BufferSizeC
Buffer size
include	"amma/BuffSize.hh"
User Level:	Default
Library:	Mbuff
Example:	exBRefC.cc
Section:	Containers.Arrays.Buffer
In Scope:	std

Comments:
The class BufferSizeC keeps information about the size of buffer.

SizeT n;

The number of items accessible by this buffer access.

BufferSizeC(SizeT size = 0)

Creates an object keeping the information of buffer size.

BufferSizeC(const BufferSizeC & ba)

Creates a physical copy of the buffer size 'ba'.

const BufferSizeC & operator=(const BufferSizeC & bp)

Assigment. Access to the object --------------------

SizeT N() const

Returns the number of elements of the array.

SizeT Size() const

Returns the number of elements of the array.

IndexT Min() const

Returns the minimum index of the range, ie. 0.

IndexT Max() const

Returns the maximum index of the range, ie. N()-1.

const BufferSizeC & Limits() const

Returns the usable range of indeces expressed by 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'.

BooleanT In(const BufferSizeC & range) const

Returns TRUE if the size of this object is smaller of equal to the the size of object 'range'. Modifications of the access ---------------------------

BufferSizeC & ShrinkHigh(const SizeT k)

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

BufferSizeC & ShrinkLow(const SizeT k)

Changes the number of elements by subtracting the first 'k' elements and shifting all items in such a way that the new first element has index 0.

BufferSizeC & Shrink(const SizeT k)

Changes the number of elements by subtracting the first 'k' and the last 'k' elements. After that all item indeces are shifted in such a way that the new first element has index 0.

void Swap(BufferSizeC & a)

Exchanges the contents of this buffer size and buffer size 'a'.