RangeBufferAccess2dC<class DataT> - Basic access to buffer with limited size

Developer Documentation

RAVL, Recognition And Vision Library

USER

Ravl - Core - Arrays - Buffer - RangeBufferAccess2dC<class DataT>

RangeBufferAccess2dC<class DataT>

Basic access to buffer with limited size

include	"Ravl/RBfAcc2d.hh"
Created:	24/01/2001
Source file:	Ravl/Core/Container/Buffer/RBfAcc2d.hh
User Level:	Develop
Library:	RavlCore
In Scope:	RavlN

Comments:
The class RangeBufferAccessC enables to random indexed access to a sequentially organised continous part of memory called buffer. The access functions check if an accessed element is valid only in debug mode.

Parent Classes:

RangeBufferAccessC

BufferAccessC

Derived Classes:

Array2dC

Variables:

IndexRangeC rng2;

Methods:

RangeBufferAccess2dC(const IndexRangeC & nrng2): Constructor.
RangeBufferAccess2dC(const RangeBufferAccessC<BufferAccessC<DataT>> & ab,const IndexRangeC & nrng2): Constructor.
RangeBufferAccess2dC(const RangeBufferAccessC<BufferAccessC<DataT>> & ab,const IndexRange2dC & rect): Construct a access to a rectangle within 'ab' with indexs 'rect'.
RangeBufferAccess2dC(const RangeBufferAccessC<BufferAccessC<DataT>> & ab,const IndexRangeC & r1,const IndexRangeC & r2): Construct a access to a rectangle within 'ab' with ranges r1 and r2.
RangeBufferAccess2dC(const BufferAccessC<BufferAccessC<DataT>> & ab,const IndexRangeC & r1,const IndexRangeC & r2): Construct a access to a rectangle within 'ab' with ranges r1 and r2.
All the offsets for the buffers should already be setup.
RangeBufferAccess2dC(): Default constructor.
DataT & operator [](const Index2dC & i): access to the item array[(i)]
const DataT & operator [](const Index2dC & i) const: return the item array[(i)]
RangeBufferAccessC<DataT> operator [](IndexC i): access to the item array[(i)]
const RangeBufferAccessC<DataT> operator [](IndexC i) const: return the item array[(i)]
const IndexRangeC & Range1() const: Range of first index.
const IndexRangeC & Range2() const: Range of second index.
UIntT Size() const: Get the total number of elements in the array.
void Fill(const DataT & d): Fill array with value.
IndexRange2dC Rectangle() const: Return ranges of indexes
IndexRange2dC Frame() const: Return ranges of indexes
bool Contains(const Index2dC & i) const: Returns TRUE if there is an item of the 2D array
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.
bool IsEmpty() const: Is rectangle empty ?
BufferAccess2dIterC<DataT> Iter(): Creat an iterator for this buffer.
BufferAccessC<DataT> & RowPtr(IndexC i): Access element 0 of row i.
Note: The element may not actually exist.
Advanced uses only!
void SetRowPtr(IndexC i,BufferAccessC<DataT> & rowPtr): Set element 0 of row i to 'rowPtr'.
Advanced uses only!
This directly manipulates the row pointer table. It can be used to change the way the array is stored. NOTE: Many of the numerical operations in RAVL assume the data is stored in linearly in a contiguous chunk of memory. Manipulating the layout with this method will break this method will break this assumption. This method is provided to allow operations like deinterlacing image to be done without copying large amounts of memory.

#include "Ravl/RBfAcc.hh"

const RangeBufferAccessC<BufferAccessC<DataT>> & operator =(BufferAccessC<DataT> * bp): Changes the reference element to the element pointed by 'bp'.
Access to the object -------------------- inline const BufferAccessC & Access(void) const; Returns this object.
BufferAccessC<DataT> * DataStart(): Returns the address of the first element of the buffer.
const 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.
const 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 [](IndexC i) const: Read-only access to the ('i'+1)-th element of the buffer.
BufferAccessC<DataT> & operator [](IndexC i): Read-write access to the ('i'+1)-th element of the buffer.
const RangeBufferAccessC<BufferAccessC<DataT>> & RAccess(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'.
bool IsOverlapping(const RangeBufferAccessC<BufferAccessC<DataT>> & 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<BufferAccessC<DataT>> & operator +=(SizeT i): Changes indeces of the access to be 'i' units higher.
RangeBufferAccessC<BufferAccessC<DataT>> operator +(SizeT i) const: Creates the new access object with the indeces 'i' units higher than those used in this access object.
const IndexRangeC & ShrinkHigh(SizeT k): Changes the number of elements by subtracting the last 'k' elements.
void ShiftIndexes(IndexC offset): All indexes of the items will be changed by 'offset'.
The range will be shifted by -offset.
void SetSubRange(IndexC newMin,IndexC newMax): Constrain the indexs that can be accessed from the array.
The range of indexes of this array will be constrained to cover the index range at most.
const RangeBufferAccessC<BufferAccessC<DataT>> & Swap(RangeBufferAccessC<BufferAccessC<DataT>> & a): Exchanges the contents of this buffer with buffer 'a'.
void Swap(IndexC i1,IndexC i2): Exchanges the contents of elements with indeces 'i1' and 'i2'.
void Attach(const RangeBufferAccessC<BufferAccessC<DataT>> & b): Changes this buffer access to have the same access rights as 'b'.
void Attach(const BufferAccessC<BufferAccessC<DataT>> & b,const IndexRangeC & r): Changes this buffer access to have the access rights as 'b' limited by range 'r'. so the first element in 'b' is accessed at 'r.Min()'.
RangeBufferAccessC<BufferAccessC<DataT>> BufferFrom(IndexC first): Get an access for this buffer starting from the 'first' element to the end of the buffer.
RangeBufferAccessC<BufferAccessC<DataT>> BufferFrom(IndexC 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. Modifications of the buffer contents ------------------------------------
void Fill(const BufferAccessC<DataT> & d): Fill the buffer with the value 'd'.
void Reverse(): Reverse the order of elements in this array in place.
bool operator ==(const RangeBufferAccessC<BufferAccessC<DataT>> & ba) const: Are two accesses the same ?
RangeBufferAccessC<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: 24/01/2001, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002