SArray2dC<class DataT> - Simple 2 dimentional array.

Developer Documentation

RAVL, Recognition And Vision Library

USER

Ravl - Core - Arrays - 2D - SArray2dC<class DataT>

SArray2dC<class DataT>

Simple 2 dimentional array.

include	"Ravl/SArray2d.hh"
Created:	10/09/1998
Source file:	Ravl/Core/Container/SArray/SArray2d.hh
User Level:	Advanced
Library:	RavlCore
In Scope:	RavlN

Parent Classes:

SizeBufferAccess2dC

Derived Classes:

TMatrixC

RealHistogram2dC

Typedefs:

typedef DataT ElementT;: Allow function templates to find type of array.
typedef SArray2dIterC<DataT> IteratorT;: Type of iterator.

Variables:

Buffer2dC data;: Handle to data.

Methods:

SArray2dC(): Default constructor.
Creates a zero size array.
SArray2dC(SizeT dim1,SizeT dim2): Constructor.
Create a dim1 by dim2 array.
SArray2dC(IndexC dim1,IndexC dim2): Constructor.
Create a dim1 by dim2 array.
SArray2dC(const Index2dC & size): Constructor.
Create a size[0] by size[1] array.
SArray2dC(const BufferC<DataT> & bf,SizeT size1,SizeT size2,SizeT startOffset = 0,SizeT stride = 0): Constructor using the buffer 'bf'.
This can be used, for example to view a 1d array, as a 2d array. startOffset is the location in the buffer to use as 0,0. If stride is set to zero, size2 is used.
SArray2dC(SArray2dC<DataT> & arr,SizeT size1,SizeT size2): Construct an access to a sub array of this one.
SArray2dC<DataT> Copy() const: Copy array.

Special operations

Buffer2dC<DataT> & Buffer(): Access base data buffer.
Experts only!
const Buffer2dC<DataT> & Buffer() const: Constant access base data buffer.
Experts only!
SArray1dC<DataT> AsVector(bool alwaysCopy = false): Access 2d array as 1d vector.
This will only copy the data if the data isn't continuous or alwaysCopy is true, this can make it much more effecient than a straigh copy.
SArray2dC<DataT> operator +(const SArray2dC<DataT> & arr) const: Sums 2 numerical arrays. The operator returns the result as a new array.
SArray2dC<DataT> operator -(const SArray2dC<DataT> & arr) const: Subtracts 2 numerical arrays. The operator returns the result as a new array.
SArray2dC<DataT> operator *(const SArray2dC<DataT> & arr) const: Mutliplies 2 numerical arrays. The operator returns the result as a new array.
SArray2dC<DataT> operator /(const SArray2dC<DataT> & arr) const: Devides 2 numerical arrays. The operator returns the result as a new array.
SArray2dC<DataT> operator *(const DataT & number) const: Multiplys the array by the 'number'. The operator returns the result as a new array.
SArray2dC<DataT> operator /(const DataT & number) const: Divides all array items by the 'number'. The operator returns the result as a new array.
SArray2dC<DataT> operator +(const DataT & number) const: Adds 'number' to the array. The operator returns the result as a new array.
SArray2dC<DataT> operator -(const DataT & number) const: Subtracts 'number' from all array items. The operator returns the result as a new array.
const SArray2dC<DataT> & operator +=(const SArray2dC<DataT> & arr): Adds the 2nd array to this array.
const SArray2dC<DataT> & operator -=(const SArray2dC<DataT> & arr): Subtracts the 2nd array from this array.
const SArray2dC<DataT> & operator *=(const SArray2dC<DataT> & arr): Multiplies the 2nd array to this array.
const SArray2dC<DataT> & operator /=(const SArray2dC<DataT> & arr): Divides the 2nd array from this array.
const SArray2dC<DataT> & operator +=(const DataT & number): Adds 'number' to all array items.
const SArray2dC<DataT> & operator -=(const DataT & number): Subtracts 'number' from all array items.
const SArray2dC<DataT> & operator *=(const DataT & number): Multiplies the array by the 'number'.
const SArray2dC<DataT> & operator /=(const DataT & number): Divides the array elements by the 'number'.
DataT SumSqr() const: Calculate the sum of the squares of all the elements in the array
DataT Sum() const: Returns the sum all elements of the array.
Slice1dC<DataT> Diagonal(): Take a slice along the diagonal of the array.
SArray1dC<DataT> SliceRow(IndexC i): Access row as 1d array.
NB. Changes made to the slice will also affect this array!
Slice1dC<DataT> SliceColumn(IndexC i): Access columb as 1d slice.
NB. Changes made to the slice will also affect this array!
void SetColumn(IndexC i,const SArray1dC<DataT> & val): Set the values in the column i to those in 'val'.
'val' must have a size equal to the number of rows.
void SetRow(IndexC i,const SArray1dC<DataT> & val): Set the values in the row i to those in 'val'.
'val' must have a size equal to the number of columns
SArray2dC(Buffer2dC<DataT> & bf,const BufferAccessC<BufferAccessC<DataT>> & ab,SizeT dim1,SizeT dim2): Construct from a buffer, and an existing buffer access.
void BuildAccess(UIntT offset = 0,UIntT stride = 0)

#include "Ravl/SBfAcc2d.hh"

bool Contains(const Index2dC & i) const: Does this buffer contain the index i ?
Returns true if yes.
DataT & operator [](const Index2dC & i): access to the item array[(i)]
const DataT & operator [](const Index2dC & i) const: return the item array[(i)]
SizeBufferAccessC<DataT> operator [](IndexC i): access to the item array[(i)]
const SizeBufferAccessC<DataT> operator [](IndexC i) const: return the item array[(i)]
SizeT Size1() const: Size.
SizeT Size2() const: Size.
UIntT Size() const: Get the total number of elements in the array.
void Fill(const DataT & d): Fill array with value.
IntT Stride() const: Get the stide of the 2d array.
bool IsContinuous() const: Test if the array is allocated in a continous area of memory.
Note: this only checks the first two rows follow each other in memory, this may miss other discontunities.

#include "Ravl/SBfAcc.hh"

const SizeBufferAccessC<BufferAccessC<DataT>> & operator =(BufferAccessC<DataT> * bp): Changes the reference element to the element pointed by 'bp'. Access to the object --------------------
BufferAccessC<DataT> * DataStart() const: Returns the address of the first element of the buffer.
SizeT Size() const: Returns the number of elements of the array.
IndexRangeC Limits() const: Returns the usable range of indeces expressed by this object.
IndexRangeC Range() const: Returns the usable range of indeces expressed by this object.
IndexC IMin() const: Returns the minimum index of the range of this access.
IndexC IMax() const: Returns the maximum index of the range of this access.
const BufferAccessC<DataT> & operator [](const IndexC i) const: Read-only access to the ('i'+1)-th element of the buffer.
BufferAccessC<DataT> & operator [](const IndexC i): Read-write access to the ('i'+1)-th element of the buffer.
const SizeBufferAccessC<BufferAccessC<DataT>> & SAccess(void) const: Returns this object. Logical functions -----------------
bool IsEmpty() const: Returns TRUE if the size of the array is zero.
bool Contains(IndexC i) const: Returns TRUE if the array contains an item with the index 'i'. Modifications of the access ---------------------------
SizeT ShrinkHigh(SizeT k): Changes the number of elements by subtracting the last 'k' elements.
const SizeBufferAccessC<BufferAccessC<DataT>> & Swap(SizeBufferAccessC<BufferAccessC<DataT>> & a): Exchanges the contents of this buffer with buffer 'a'.
void Attach(const SizeBufferAccessC<BufferAccessC<DataT>> & b): Changes this buffer access to have the same access rights as 'b'.
void Attach(const BufferAccessC<BufferAccessC<DataT>> & b,SizeT size): Changes this buffer access to have the access rights as 'b' limited for 'size' elements.
SizeBufferAccessC<BufferAccessC<DataT>> operator +(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 BufferAccessC<DataT> & d): 'd' value is assigned to all elements of the buffer.
void CopyFrom(const SizeBufferAccessC<BufferAccessC<DataT>> & oth): Copy contents of another buffer into this one.
NB. Buffers MUST be the same length.
void Reverse(): Reverse the order of elements in this array in place.
SizeBufferAccessC<BufferAccessC<DataT>> BufferFrom(UIntT first): Get an access for this buffer starting from the 'first' element to the end of the buffer.
SizeBufferAccessC<BufferAccessC<DataT>> BufferFrom(UIntT first,UIntT len): Get an access for this buffer starting from the 'first' element for 'len' elements.
An error will be generated if the requested buffer isn't contains within this one.
bool operator ==(const SizeBufferAccessC<BufferAccessC<DataT>> & ba) const: Are two accesses the same ?
SizeBufferAccessC<BufferAccessC<DataT>> 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.

#include "Ravl/BufferAccess.hh"

BufferAccessC<DataT> * ReferenceElm() 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() 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.
bool IsValid() const: Returns TRUE if this buffer access is not a default access object.
const BufferAccessC<DataT> & operator [](const IndexC i) const: Read-only access to the ('i'+1)-th element of the buffer.
BufferAccessC<DataT> & operator [](const IndexC i): Read-write access to the ('i'+1)-th element of the buffer.
const BufferAccessC<BufferAccessC<DataT>> & operator +=(IndexC ind): Inplace Add index to start position.
const BufferAccessC<BufferAccessC<DataT>> & operator -=(IndexC ind): Inplace Subtract index from start position.
BufferAccessC<BufferAccessC<DataT>> operator -(IndexC ind) const: Substract value from position, and return it as a new value.
BufferAccessC<BufferAccessC<DataT>> operator +(IndexC ind) const: Substract value from position, and return it as a new value.
bool operator ==(const BufferAccessC<BufferAccessC<DataT>> & ba) const: Are two accesses the same ?
bool operator !=(const BufferAccessC<BufferAccessC<DataT>> & ba) const: Are two accesses the same ?

Maintainer:Charles Galambos, Created: 10/09/1998, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002