RealArray1dC - 1 Dimensional real array

Developer Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

NumArray1dC

Derived Classes:

DFunction1dC

Enumerated types:

enum SortOrderT { INCREASING, DECREASING } ;

Typedefs:

typedef int MaskSizeT;

Methods:

RealArray1dC(): Creates an empty array.
RealArray1dC(const SizeT dim): an real array with the range <0, 'dim'-1>
RealArray1dC(const IndexRangeC & range): an real array with the range <'range'.Min(), 'range'.Max()>
RealArray1dC(const RealArray1dC & vv): another access to the real array 'vv'
RealArray1dC(const RealArray1dC & vv,const IndexRangeC & range): real subarray of the 'vv' with the 'range'
RealArray1dC(RealT * data,const IndexRangeC & range): the RealT array is created from the memory location 'data' with the range of access in <'range'.Min(), 'range'.Max()> 'data' is not deallocated during destructing of the array
RealArray1dC(const char * fileName): Creates a real array from the file 'fileName'.
RealArray1dC(istream & s): A real array is created from the input stream 's'
IndexT MinIndex() const: find the index of the minimal item
IndexT MaxIndex() const: find the index of the maximal item
IndexT FirstGreaterIndex(const RealT value) const: find the index from the beginning of the array of the first items which value is greater than 'value'
IndexT FirstGreaterAbsIndex(const RealT value) const: find the index from the beginning of the array of the first items which the absolute value is greater than 'value'
void Sort(IndexRangeC r,SortOrderT o = INCREASING): Sorts the array values inside the range 'r' into the order 'o'.
RealT SetZeroMean(): values of the array are shifted to have zero mean returns the mean value of the original values
RealT SetUnitSum(): values fo the array are normalizes to have D.C = 1 returns the sum of the original values
RealT NormAbsSum(RealT value = 1.0): Normalizes this array so that the sum of its absolute values is 'value'.
LinearSums2dC LinearSums2d() const: Returns the object serving for estimation of linear dependency.
RealArray1dC & Convolution(const RealArray1dC & mask): convolve array with the mask the result is stored in the same array
RealArray1dC Enlarge(const IntT factor = 2) const: Enlarges the real array by item duplications. Every number is duplicated 'factor' times. The return real array is extended by adding of higher indexes.
RealArray1dC Copy() const: create a copy of the array
RealArray1dC Gauss(MaskSizeT len,RealT tau): Creates the array containing Gaussian.
"len" is array size, rounded down to nearest odd no.
"tau" is ratio of cutoff to peak values (hence must be <= 1)
RealArray1dC(const NumArray1dC<RealT> & a): Creates a real value array which is attached to the array 'a'.
void SortUp(const IndexRangeC & r): Sorts the array values inside the range 'r' into the increasing order.
void SortDown(const IndexRangeC & r): Sorts the array values inside the range 'r' into the decreasing order.

#include "amma/NArray1d.hh"

const NumArray1dC<RealT> & operator=(const NumArray1dC<RealT> & arr): Assigment (of 'BIG OBJECT') Access to information on the object. ------------------------------------
const NumArray1dC<RealT> & NumArray1d() const: The access to the constant object.
NumArray1dC<RealT> & NumArray1d(): The access to the object. Arithmetical operations. ------------------------
NumArray1dC<RealT> & SetZero(): Sets all items of the array to be 0.
NumArray1dC<RealT> & Set(const RealT & number): Sets all items of the array to be 'number'. NB. This function is OBSOLETE. Use Fill() instead.
NumArray1dC<RealT> operator+(const NumArray1dC<RealT> & arr) const: Sums 2 numerical arrays. The operator returns the result as a new array.
NumArray1dC<RealT> operator-(const NumArray1dC<RealT> & arr) const: Subtracts 2 numerical arrays. The operator returns the result as a new array.
NumArray1dC<RealT> operator*(const RealT number) const: Multiplys the array by the 'number'. The operator returns the result as a new array.
NumArray1dC<RealT> operator/(const RealT number) const: Divides all array items by the 'number'. The operator returns the result as a new array.
NumArray1dC<RealT> & operator+=(const NumArray1dC<RealT> & arr): Adds the 2nd array to this array.
NumArray1dC<RealT> & operator-=(const NumArray1dC<RealT> & arr): Subtracts the 2nd array from this array.
NumArray1dC<RealT> & operator*=(const RealT number): Multiplies the array by the 'number'.
NumArray1dC<RealT> & operator/=(const RealT number): Divides the array elements by the 'number'. Logical operations. -------------------
BooleanT Contains(const RealT & v,const IndexRangeC & r) const: Returns TRUE, if value 'v' is one of the value of this array with the index inside the range 'r'.

#include "amma/Array1d.hh"

Array1dC<RealT> Copy() const: Creates a new physical copy of the array.
Array1dC<RealT> & Copy(const Array1dC<RealT> & 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<RealT> & 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<RealT> & Copy(const IndexT off,const Array1dC<RealT> & 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<RealT> & operator=(const Array1dC<RealT> & vv): Assigment, as for a BIG_OBJECT.
Access to the object elements. ------------------------------
const Array1dC<RealT> & Array1d() const: Access to the whole array.
Array1dC<RealT> & Array1d(): Access to the whole array.
SArray1dC<RealT> 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<RealT> 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<RealT> 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<RealT> & Append(const Array1dC<RealT> & 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<RealT> & 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<RealT> & operator=(RealT * bp): Changes the reference element to the element pointed by 'bp'.
Access to the object --------------------
RealT * 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<RealT> & Access(void) const: Returns this object.
RealT * DataStart(): Returns the address of the first element of the buffer..
const RealT * 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 RealT & operator[](const IndexT i) const: Read-only access to the ('i'+1)-th element of the buffer.
RealT & operator[](const IndexT i): Read-write access to the ('i'+1)-th element of the buffer.
const RangeBufferAccessC<RealT> & 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<RealT> & 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<RealT> & operator+=(const SizeT i): Changes indeces of the access to be 'i' units higher.
RangeBufferAccessC<RealT> 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<RealT> & Swap(RangeBufferAccessC<RealT> & 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<RealT> & b): Changes this buffer access to have the same access rights as 'b'.
void Attach(const BufferAccessC<RealT> & 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 RealT & d): 'd' value is assigned to all elements of the buffer.
RangeBufferAccessC<RealT> 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

RealArray1dC

1 Dimensional real array

include	"amma/ReArr1d.hh"
User Level:	Default
Library:	MstdArr
Example:	exComplx.cc
Section:	Containers.Arrays.1-D Arrays.Specialized Arrays
In Scope:	std