PUBLIC

IndexRangeC::IndexRangeC(SizeT) IndexRangeC::IndexRangeC(IndexT) IndexRangeC::IndexRangeC(IndexT,IndexT) IndexRangeC::IndexRangeC(const IndexRangeC &) IndexRangeC::IndexRangeC(istream &) IndexRangeC::operator=(const IndexRangeC &) IndexRangeC::Size(void) const IndexRangeC::Range(void) const IndexRangeC::Min(void) const IndexRangeC::Max(void) const IndexRangeC::Min(void) IndexRangeC::Max(void) IndexRangeC::Center(void) const IndexRangeC::CenterD(void) const IndexRangeC::Percentage(const PercentT) const IndexRangeC::IsEmpty(void) const IndexRangeC::Contains(const IndexT) const IndexRangeC::operator==(const IndexRangeC &) const IndexRangeC::operator!=(const IndexRangeC &) const IndexRangeC::In(const IndexRangeC &) const IndexRangeC::IsOverlapping(const IndexRangeC &) const IndexRangeC::operator+(const IndexT) const IndexRangeC::operator+=(const IndexT) IndexRangeC::operator-=(const IndexT) IndexRangeC::Clip(const IndexRangeC &) IndexRangeC::FirstHalf(void) const IndexRangeC::FirstHalfD(void) const IndexRangeC::Enlarge(const IndexT) const IndexRangeC::Extend(const IndexT) IndexRangeC::ShrinkHigh(const IndexT) IndexRangeC::Swap(IndexRangeC &)

IndexRangeC
1D index range of array
include	"amma/IndexR1d.hh"
User Level:	Default
Library:	MIndex1
Example:	exBRefC.cc
Section:	Basic Types.Indexing
In Scope:	std

Comments:
The class IndexRangeC is a representation of an interval of one dimensional index.

typedef float PercentT;

Fraction of index range.

IndexRangeC(SizeT dim = 0)

Creates the index range <0, dim-1>.

IndexRangeC(IndexT dim)

Creates the index range <0, dim-1>.

IndexRangeC(IndexT minIndex,IndexT maxIndex)

Creates the index range .

IndexRangeC(const IndexRangeC & range)

Copy constructor.

IndexRangeC(istream & s)

Creates the index range from the input stream.

const IndexRangeC & operator=(const IndexRangeC & range)

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

SizeT Size() const

Returns the number of elements in the range.

const IndexRangeC & Range() const

Returns this object.

const IndexT & Min() const

Returns the minimum index of the range.

const IndexT & Max() const

Returns the maximum index of the range.

IndexT & Min()

Returns the minimum index of the range.

IndexT & Max()

Returns the maximum index of the range.

IndexT Center() const

Returns the index in the middle of the range, eg. (Max()+Min()+1)/2.

IndexT CenterD() const

Returns the index previous the middle of the range, eg. (Max()+Min())/2.

IndexT Percentage(const PercentT p) const

Returns the index which is in the 'p' % of the whole range. Logical operations. -------------------

BooleanT IsEmpty() const

Returns TRUE if the minimum limit is bigger than the maximum limit.

BooleanT Contains(const IndexT i) const

Returns TRUE if this range contains the index 'i'.

BooleanT operator==(const IndexRangeC & range) const

Returns TRUE if both index ranges have the same limits.

BooleanT operator!=(const IndexRangeC & range) const

Returns TRUE if both the ranges have different limits.

BooleanT In(const IndexRangeC & range) const

Returns TRUE if this range is inside of the 'range'.

BooleanT IsOverlapping(const IndexRangeC & r) const

Returns TRUE if this range contains at least one common index with the range 'r'. Special operations. -------------------

IndexRangeC operator+(const IndexT i) const

Returns a new range with both minimum and maximum limits shifted by adding the offset 'i'.

const IndexRangeC & operator+=(const IndexT i)

Both minimum and maximum limits are shifted by adding the offset 'i'.

const IndexRangeC & operator-=(const IndexT i)

Both minimum and maximum limits are shifted by subtracting the offset 'i'.

IndexRangeC & Clip(const IndexRangeC & r)

This index range is clipped to contain at most the index range 'r'.

IndexRangeC FirstHalf() const

Returns the index range < Min(), (Max()+Min()+1)/2 >.

IndexRangeC FirstHalfD() const

Returns the index range < Min(), (Max()+Min())/2 >.

IndexRangeC Enlarge(const IndexT f) const

Returns the index range whose number of elements is enlarged by the factor 'f'. The upper limits is changed.

IndexRangeC & Extend(const IndexT n)

Returns the range extended by adding 'n' items on both limits of this range.

IndexRangeC & ShrinkHigh(const IndexT n)

Returns the range shrinked by removing of the last 'n' items on both limits of this range.

IndexRangeC & Swap(IndexRangeC & r)

Exchanges the contents of this range and range 'r'. The function returns this range.