|
Developer Documentation |
|
Centre for Vision, Speech & Signal Processing |
Comments:
The class RealSArray1dC is a simple container with a fixed number of real
numbers which can be accessed randomly using indexing. The indexes
start from 0.
The class RealSArray1dC is a big object, eg. it has a reference counter.
Parent Classes:
Derived Classes:
Methods:
- RealSArray1dC()
-
Empty array.
- RealSArray1dC(const SizeT dim)
-
A non-initialized array with the range <0, 'dim'-1>.
- RealSArray1dC(const RealSArray1dC & vv)
-
Another access to the array 'vv'.
- RealSArray1dC(const SArray1dC<RealT> & vv)
-
Another access to the array 'vv'.
- RealSArray1dC(RealT * data,const SizeT dim)
-
An array is created from the memory location 'data' with the range
of access in <0, 'dim'-1>.
'data' is not deallocated during destructing of the array.
- RealSArray1dC(istream & s)
-
Creates the real array from the input stream 's'.
- RealSArray1dC Copy() const
-
Creates a new physical copy of the real array.
Special operations.
-------------------
- RealSArray1dC operator*(const RealT & r) const
-
Multiples every item of the array by the real number 'r'.
- const RealSArray1dC & operator+=(const RealSArray1dC & arr)
-
Adds the array 'arr' to this array. The operation is performed
on the overlapping part of the arrays only. The function returns
this array.
- const RealSArray1dC & operator-=(const RealSArray1dC & arr)
-
Subtracts the array 'arr' to this array. The operation is performed
on the overlapping part of the arrays only. The function returns
this array.
- const RealSArray1dC & operator*=(const RealT & r)
-
Multiplies each element of this array by the real number 'r'.
- const RealSArray1dC & operator/=(const RealT & r)
-
Divides each element of this array by the real number 'r'.
- void SetZero()
-
Sets all items of the array to be zero.
- RealT MaxValue() const
-
Returns the maximum value saved in the array.
- IndexT MaxIndex() const
-
Returns the index of the maximum value.
- IndexT MinIndex() const
-
Returns the index of the minimum value.
- IndexT MaxAbsIndex() const
-
Returns the index of the maximum absolute value.
- RealT Sum() const
-
Returns the sum of all elements in the array.
- RealSArray1dC & StraightSort()
-
Sorts the array into ascending numerical order by straight
insertion. It is an N^2 routine, and should only be used
for small N, say < 50.
- RealSArray1dC & StraightSort(const SizeT n)
-
Sorts the first n element of the array into ascending numerical
order by straight insertion. It is an N^2 routine, and should
only be used for small 'n', say < 50.
- RealSArray1dC Join(const RealSArray1dC & it) const
-
Join this array with another.
- SArray1dC<RealT> Copy() const
-
Creates a new physical copy of the array.
- const SArray1dC<RealT> & operator=(const SArray1dC<RealT> & vv)
-
Assigment, as for a BIG_OBJECT.
Access to the object and its parts.
-----------------------------------
- const SArray1dC<RealT> & SArray1d() const
-
Access to the whole constant array.
- SArray1dC<RealT> & SArray1d()
-
Access to the whole array.
Modifications of the representation
-----------------------------------
- SArray1dC<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.
- SArray1dC<RealT> & Append(const SArray1dC<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.
- SArray1dC<RealT> Join(const SArray1dC<RealT> & Oth) const
-
Join this Array and another into a new Array which
is returned. This does not change either of its arguments.
This is placed in the array first, followed by 'Oth'.
Special operations
------------------
- void DebugAddresses() const
-
Prints addresses into 'cerrAMMA'.
- const BodyRefCounterC & RefCounter() const
-
Returns access to reference counter.
- BufferRC<RealT> & Buffer()
-
Access base data buffer.
Experts only.
- const BufferRC<RealT> & Buffer() const
-
Constant access base data buffer.
Experts only.
- RealT * DataStart() const
-
Returns the address of the first item if exists.
- const SizeBufferAccessC<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() 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 BufferSizeC & Limits() const
-
Returns the usable range of indeces expressed by this object.
- const BufferSizeC & 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 SizeBufferAccessC<RealT> & SAccess(void) const
-
Returns this object.
Logical functions
-----------------
- 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'.
Modifications of the access
---------------------------
- const BufferSizeC & ShrinkHigh(const SizeT k)
-
Changes the number of elements by subtracting the last 'k' elements.
- const SizeBufferAccessC<RealT> & Swap(SizeBufferAccessC<RealT> & a)
-
Exchanges the contents of this buffer with buffer 'a'.
- void Attach(const SizeBufferAccessC<RealT> & b)
-
Changes this buffer access to have the same access rights as 'b'.
- void Attach(const BufferAccessC<RealT> & b,const SizeT size)
-
Changes this buffer access to have the access rights as 'b' limited
for 'size' elements.
- SizeBufferAccessC<RealT> operator+(const 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 RealT & d)
-
'd' value is assigned to all elements of the buffer.
- void CopyFrom(const SizeBufferAccessC<RealT> & oth)
-
Copy contents of another buffer into this one.
NB. Buffers MUST be the same length.
- SizeBufferAccessC<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
|