Array1dC<class DataC> - 1 Dimensional array

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
The class Array1dC is a reference counted container with a fixed number of items which can accessed in randomly using indexing in a specified range of indeces. The item is expected to have a default constructor, a copy constructor, and an assigment. The class Array1dC is a big object, eg. it has a reference counter.

BIG OBJECT

Parent Classes:

Derived Classes:

Enumerated types:

enum ExtensionT { SoftExt, HardExt } ;

Typedefs:

typedef DataC ElementT;: Allow function templates to find type of array.
typedef IndexT KeyT;: Allow function templates to find type of index.
typedef Array1dIterC<DataC> InteratorT;: Type of iterator.
Constructors, copy, assigment, and destructor ---------------------------------------------

Variables:

BufferRC buff;: The reference counted storage.

Methods:

Array1dC(): Creates an empty array.
Array1dC(const SizeT dim): An array with the range <0, 'dim'-1>.
Array1dC(const IndexRangeC & range): An array with the range <'range'.Min(), 'range'.Max()>.
Array1dC(istream & s): Creates an 1-dimensional array from the input stream.
Array1dC(const Array1dC<DataC> & vv): Another access to the array 'vv'.
Array1dC(DataC * data,const IndexRangeC & range,BooleanT removable = TRUE): An array is created from the memory location 'data' with the range of access in <'range'.Min(), 'range'.Max()>.

'data' is assumed to point to the location 'range.min()'
If flag 'removable' is FALSE, 'data' is not deallocated during destructing of the array, unless 'removable' is set to true.
Array1dC(BufferRC<DataC> & bf,const IndexRangeC & range): Creates the array with limits 'range' using the buffer 'bf'.
Array1dC(BufferRC<DataC> & bf,const RangeBufferAccessC<DataC> & rbf): Creates the array in 'bf' using access rbf..
Array1dC(const Array1dC<DataC> & vv,const IndexRangeC & range): The subarray of the 'vv' with the 'range'.
Array1dC(const SArray1dC<DataC> & oth): Construct an array from a SArray1dC.
Note: This does NOT make a copy, it just creates another access to the buffer.
Array1dC<DataC> Copy() const: Creates a new physical copy of the array.
Array1dC<DataC> & Copy(const Array1dC<DataC> & orig): Copies values from the 'orig' array into this array.
Only items from the overlapping part of the ranges are copied. The function returns this array.
Array1dC<DataC> & Copy(const IndexRangeC & r,const IndexT off): Copies values from the index range 'r' into the new position with the offset 'off'.
Only those items which original position and destination are inside of the index range of this array are copied.
Array1dC<DataC> & Copy(const IndexT off,const Array1dC<DataC> & a): Copies the maximum possible part of array 'a' into this array.
The first element of array 'a' is placed into the element of this array with index 'off'. The functio returns this array.
const Array1dC<DataC> & operator=(const Array1dC<DataC> & vv): Assigment, as for a BIG_OBJECT.
Access to the object elements. ------------------------------
const Array1dC<DataC> & Array1d() const: Access to the whole array.
Array1dC<DataC> & Array1d(): Access to the whole array.
SArray1dC<DataC> SArray1d(): Create an access as an sarray.
NB. This does NOT copy the data, it only make a new access to it. If the array does not have contain element '0' an error will occure in check mode, when optimised is enabled an empty array will be returned. In anycase only elements 0 and above will be accessable. Array representation modifications. -----------------------------------
Array1dC<DataC> 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.
Array1dC<DataC> Extend(const SizeT n) const: Returns the array whose range is extended by adding 'n' items with default value from both limits of the range.
This array value are copied into the same index positions in the returned array.
Array1dC<DataC> & Append(const Array1dC<DataC> & 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. Logical operations. -------------------
BooleanT IsSharing(const Array1dC<DataC> & arr) const: Returns TRUE if this array and the array 'arr' are subarrays of the the same array.
Special operations. -------------------
void DebugAddresses() const: Prints addresses into 'cerrAMMA'.
const BodyRefCounterC & RefCounter() const: Returns access to reference counter.

#include "amma/RBfAcc.hh"

const RangeBufferAccessC<DataC> & operator=(DataC * bp): Changes the reference element to the element pointed by 'bp'.
Access to the object --------------------
DataC * 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<DataC> & Access(void) const: Returns this object.
DataC * DataStart(): Returns the address of the first element of the buffer..
const DataC * 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 IndexRangeC & Limits() const: Returns the usable range of indeces expressed by this object.
const IndexRangeC & 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 DataC & operator[](const IndexT i) const: Read-only access to the ('i'+1)-th element of the buffer.
DataC & operator[](const IndexT i): Read-write access to the ('i'+1)-th element of the buffer.
const RangeBufferAccessC<DataC> & RAccess(void) const: Returns this object. Logical functions -----------------
BooleanT IsValid() const: Returns TRUE if this buffer access is not a default access object.
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 IsOverlapping(const RangeBufferAccessC<DataC> & acc) const: Returns TRUE if this access has an item with the same index as an item of the access 'acc'. Modifications of the access ---------------------------
const RangeBufferAccessC<DataC> & operator+=(const SizeT i): Changes indeces of the access to be 'i' units higher.
RangeBufferAccessC<DataC> operator+(const SizeT i) const: Creates the new access object with the indeces 'i' units higher than those used in this access object.
const IndexRangeC & ShrinkHigh(const SizeT k): Changes the number of elements by subtracting the last 'k' elements.
void ShiftIndexes(const IndexT offset): All indexes of the items will be changed by 'offset'.
The range will be shifted by -offset.
void SetSubRange(const IndexT newMin,const IndexT newMax): The range of indexes of this array will be constrained to cover the index range at most.
const RangeBufferAccessC<DataC> & Swap(RangeBufferAccessC<DataC> & a): Exchanges the contents of this buffer with buffer 'a'.
void Swap(const IndexT i1,const IndexT i2): Exchanges the contents of elements with indeces 'i1' and 'i2'.
void Attach(const RangeBufferAccessC<DataC> & b): Changes this buffer access to have the same access rights as 'b'.
void Attach(const BufferAccessC<DataC> & b,const IndexRangeC & r): Changes this buffer access to have the access rights as 'b' limited by range 'r'. Modifications of the buffer contents ------------------------------------
void Fill(const DataC & d): 'd' value is assigned to all elements of the buffer.
RangeBufferAccessC<DataC> 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.

Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

Array1dC<class DataC>

1 Dimensional array

include	"amma/Array1d.hh"
User Level:	Default
Library:	Marr1
Example:	exBuffer.cc
Section:	Containers.Arrays.1-D Arrays
In Scope:	std