VectorMatrixC - A vector and a matrix together for n-D space

Developer Documentation

RAVL, Recognition And Vision Library

USER

Ravl - Math - Linear Algebra - VectorMatrixC

VectorMatrixC

A vector and a matrix together for n-D space

include	"Ravl/VectorMatrix.hh"
Source file:	Ravl/Math/LinearAlgebra/General/VectorMatrix.hh
User Level:	Normal
Library:	RavlMath
In Scope:	RavlN

Parent Classes:

VectorC

MatrixC

Methods:

VectorMatrixC(): Empty object
VectorMatrixC(const UIntT dim): Constructor of an empty vector and matrix of the dimension 'dim'.
VectorMatrixC(const VectorC & vec,const MatrixC & mat): Constructs the object from the vector 'vec' and the matrix 'mat'. The new object contains handles of 'vec' and 'matrix' (BIG OBJECT).
VectorMatrixC(const VectorMatrixC & vm): Copy constructor.
const VectorC & Vector() const: Access to the vector.
const MatrixC & Matrix() const: Access to the matrix.
VectorC & Vector(): Non-constant access to the vector.
MatrixC & Matrix(): Non-constant access to the matrix.
VectorMatrixC Copy() const: Returns the physical copy of this vector matrix.
void SetZero(): Zeros the vector and the matrix.
void Sort(): Sort in place according to the vector value.
The first value will be the biggest one.
istream & operator >>(istream & s,VectorMatrixC & vm)

#include "Ravl/Vector.hh"

explicit VectorC(UIntT size): Constructor.
Create a vector of 'size' elements
bool IsReal() const: Test if vector only contains real values.
This will return false if either nan's (Not an number) or infinite values are found.

#include "Ravl/Matrix.hh"

bool IsReal() const: Test if matrix only contains real values.
This will return false if either nan's (Not an number) or infinite values are found.
MatrixC Inverse() const: Calculate the inverse of this matrix.
an invalid matrix is returned if this matrix is singular.
bool InverseIP(): Calculate the inverse of this matrix in place.
Returns false if matrix is singular.
Notes: The matrix must be square
If the matrix is not stored in a continous area of memory a slightly different routine is used to do the inversion.
MatrixC PseudoInverse(RealT thresh = 1 e - 5) const: Do a pseudo inverse
Uses singular value decomposition to decompose the matrix, and sets the singular values smaller than 'thesh' to zero.
RealT Det() const: Calculate the determinant of the matrix.

#include "Ravl/TVector.hh"

explicit TVectorC(SizeT n): Constructor.
operator TFVectorC<RealT,N>(): Convert to a fixed size vector.
RealT Sum() const: Returns the sum all elements of the vector.
RealT Product() const: Returns the product of all elements of the vector.
RealT SumOfSqr() const: Returns the sum of the squares of all the elements of the vector.
RealT SumOfAbs() const: Returns the sum of the absolute values of all the elements of the vector.
RealT MaxValue() const: Largest value in the array.
RealT MaxMagintude() const: Value of the largest magnitude in the vector.
RealT MinValue() const: Smalleset value in the array.
const TVectorC<RealT> & Reciprocal(): All elements of the vector are changed to their reciprocal values. It is assumed that all elements of the vector differs from zero.
RealT Modulus() const: Returns the modulus of the vector.
The Sqrt(SumOfSqr()).
RealT TMul(const TVectorC<RealT> & b) const: multiplication 'DataT' = (*this).T() * b
RealT Dot(const TVectorC<RealT> & v) const: scalar product of vectors
const TVectorC<RealT> & SetSmallToBeZero(const RealT & min): Set values smaller than 'min' to zero in vector.
TMatrixC<RealT> OuterProduct(const TVectorC<RealT> & a) const: Calculate the outer product of this vector and a.
To use the function you must also include 'Ravl/Matrix.hh'.
TMatrixC<RealT> OuterProduct(const TVectorC<RealT> & a,RealT b) const: Calculate the outer product of this vector and a multiplied by b.
To use the function you must also include 'Ravl/Matrix.hh'.
TMatrixC<RealT> OuterProduct() const: Calculate the outer product of this vector with itself.
To use the function you must also include 'Ravl/Matrix.hh'.
TVectorC<RealT> Unit() const: Return a unit vector
const TVectorC<RealT> & MakeUnit(): Make this a unit vector.
IndexC MaxIndex() const: Find the index with the most positive valued index.
IndexC MaxAbsIndex() const: Find the index with the absolute maximum valued index.

#include "Ravl/TMatrix.hh"

operator TFMatrixC<RealT,N,M>(): Convert to fixed size matrix.
SizeT Rows() const: Return the number of rows
SizeT Cols() const: Return the number of columns
TMatrixC<RealT> operator *(RealT val) const: Multiply by a constant.
TVectorC<RealT> operator *(const TVectorC<RealT> & vector) const: Multiplication "TVectorC" = "This" * vector
TMatrixC<RealT> operator *(const TMatrixC<RealT> & mat) const: Multiplication "result" = "this" * "mat"
TMatrixC<RealT> MulT(const TMatrixC<RealT> & B) const: Multiplication A * B.T()
TMatrixC<RealT> TMul(const TMatrixC<RealT> & B) const: Multiplication A.T() * B
TVectorC<RealT> TMul(const TVectorC<RealT> & vec) const: Multiplication A.T() * vec
TMatrixC<RealT> AAT() const: Return A * A.T().
TMatrixC<RealT> ATA() const: Return A.T() * A.
TMatrixC<RealT> T() const: Get transpose of matrix.
static TMatrixC<RealT> Identity(UIntT n): Returns an identity matrx of n by n.
NB. This is a static function and should be called MatrixC::Identity(n). where n is the size of the matrix.
const TMatrixC<RealT> & SetDiagonal(const TVectorC<RealT> & d): Set the diagonal of this matrix.
If d.Size() != Cols() an error is given.
const TMatrixC<RealT> & AddDiagonal(const TVectorC<RealT> & d): Add a vector to the diagonal of this matrix.
If d.Size() != Cols() an error is given.
TMatrixC<RealT> SubMatrix(SizeT size1,SizeT size2): Get sub matrix of size1,size2.
The creates a new access, but does not copy the data itself. The matrix always starts from 0,0.
RealT SumOfAbs() const: Sum the absolute values of all members of the matrix.
const TMatrixC<RealT> & AddOuterProduct(const TVectorC<RealT> & vec1,const TVectorC<RealT> & vec2): Add outer product of vec1 and vec2 to this matrix.
const TMatrixC<RealT> & AddOuterProduct(const TVectorC<RealT> & vec1,const TVectorC<RealT> & vec2,const RealT & a): Add outer product of vec1 and vec2 multiplied by a to this matrix .
const TMatrixC<RealT> & SetSmallToBeZero(const RealT & min): Set values smaller than 'min' to zero in vector.
void SwapRows(int i,int j): Swap two rows in the matrix.

Constructors, assigment, and destructor

#include "Ravl/SArray1d.hh"

SArray1dC<RealT> Copy() const: Creates a new physical copy of the array.
SArray1dC<RealT> Copy(UIntT extend) const: Creates a new physical copy of the array.
'extend' extra elements initalised by the default constuctor are appended to the end of the array.
void CopyFrom(const Slice1dC<RealT> & slice): Copy contents of slice into array.
The first element of the slice is copied to element 0 of this array, second to 1 etc. If this array isn't large enough an exception is thrown.
const SArray1dC<RealT> & operator =(const SArray1dC<RealT> & vv): Assign this handle to the data in VV.
SArray1dC<RealT> operator +(const SArray1dC<RealT> & arr) const: Sums 2 numerical arrays.
The operator returns the result as a new array.
SArray1dC<RealT> operator -(const SArray1dC<RealT> & arr) const: Subtract 2 numerical arrays.
The operator returns the result as a new array.
SArray1dC<RealT> operator *(const SArray1dC<RealT> & arr) const: Mutliplies 2 numerical arrays.
The operator returns the result as a new array.
SArray1dC<RealT> operator /(const SArray1dC<RealT> & arr) const: Divides 2 numerical arrays.
The operator returns the result as a new array.
SArray1dC<RealT> operator *(const RealT & number) const: Multiplys the array by the 'number'.
The operator returns the result as a new array.
SArray1dC<RealT> operator /(const RealT & number) const: Divides all array items by the 'number'.
The operator returns the result as a new array.
SArray1dC<RealT> operator +(const RealT & number) const: Adds 'number' to the array.
The operator returns the result as a new array.
SArray1dC<RealT> operator -(const RealT & number) const: Subtracts 'number' from all array items.
The operator returns the result as a new array.
const SArray1dC<RealT> & operator +=(const SArray1dC<RealT> & arr): Adds the 2nd array to this array.
const SArray1dC<RealT> & operator -=(const SArray1dC<RealT> & arr): Subtracts the 2nd array from this array.
const SArray1dC<RealT> & operator *=(const SArray1dC<RealT> & arr): Multiplies the 2nd array to this array.
const SArray1dC<RealT> & operator /=(const SArray1dC<RealT> & arr): Divides the 2nd array from this array.
const SArray1dC<RealT> & operator +=(const RealT & number): Adds 'number' to all array items.
const SArray1dC<RealT> & operator -=(const RealT & number): Subtracts 'number' from all array items.
const SArray1dC<RealT> & operator *=(const RealT & number): Multiplies the array by the 'number'.
const SArray1dC<RealT> & operator /=(const RealT & number): Divides the array elements by the 'number'.
RealT Sum() const: Calculate the sum of all elements in the array
RealT SumSqr() const: Calculate the sum of the squares of all elements in the array

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.
Slice1dC<RealT> Slice1d(): Access array as a slice.

Modifications of the representation

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. Empty arrays are handled correctly.
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'.
SArray1dC<RealT> From(UIntT offset): Return array from offset to the end of the array.
If offset is larger than the array an empty array is returned,
SArray1dC<RealT> From(UIntT offset,UIntT size): Return array from offset to the end of the array.
If offset is larger than the array an empty array is returned,
SArray1dC<RealT> After(UIntT offset): Return array after offset to the end of the array.
If offset is larger than the array an empty array is returned,

Special operations

BufferC<RealT> & Buffer(): Access base data buffer.
Experts only.
const BufferC<RealT> & Buffer() const: Constant access base data buffer.
Experts only.
void Sort(): Sort the array in place.
This does a simple bubble sort. FIXME:- we could do with something better!
bool operator ==(const SArray1dC<RealT> & vv): Comparison operator
Returns true if the two arrays are the same length and their contents are identical.
UIntT Hash() const: Compute a hash value for the array.
RealT * DataStart() const: Returns the address of element 0.
If the array has zero length a null pointer may be returned.

#include "Ravl/SArray2d.hh"

SArray2dC<RealT> Copy() const: Copy array.

Special operations

Buffer2dC<RealT> & Buffer(): Access base data buffer.
Experts only!
const Buffer2dC<RealT> & Buffer() const: Constant access base data buffer.
Experts only!
SArray1dC<RealT> 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<RealT> operator +(const SArray2dC<RealT> & arr) const: Sums 2 numerical arrays. The operator returns the result as a new array.
SArray2dC<RealT> operator -(const SArray2dC<RealT> & arr) const: Subtracts 2 numerical arrays. The operator returns the result as a new array.
SArray2dC<RealT> operator *(const SArray2dC<RealT> & arr) const: Mutliplies 2 numerical arrays. The operator returns the result as a new array.
SArray2dC<RealT> operator /(const SArray2dC<RealT> & arr) const: Devides 2 numerical arrays. The operator returns the result as a new array.
SArray2dC<RealT> operator *(const RealT & number) const: Multiplys the array by the 'number'. The operator returns the result as a new array.
SArray2dC<RealT> operator /(const RealT & number) const: Divides all array items by the 'number'. The operator returns the result as a new array.
SArray2dC<RealT> operator +(const RealT & number) const: Adds 'number' to the array. The operator returns the result as a new array.
SArray2dC<RealT> operator -(const RealT & number) const: Subtracts 'number' from all array items. The operator returns the result as a new array.
const SArray2dC<RealT> & operator +=(const SArray2dC<RealT> & arr): Adds the 2nd array to this array.
const SArray2dC<RealT> & operator -=(const SArray2dC<RealT> & arr): Subtracts the 2nd array from this array.
const SArray2dC<RealT> & operator *=(const SArray2dC<RealT> & arr): Multiplies the 2nd array to this array.
const SArray2dC<RealT> & operator /=(const SArray2dC<RealT> & arr): Divides the 2nd array from this array.
const SArray2dC<RealT> & operator +=(const RealT & number): Adds 'number' to all array items.
const SArray2dC<RealT> & operator -=(const RealT & number): Subtracts 'number' from all array items.
const SArray2dC<RealT> & operator *=(const RealT & number): Multiplies the array by the 'number'.
const SArray2dC<RealT> & operator /=(const RealT & number): Divides the array elements by the 'number'.
RealT SumSqr() const: Calculate the sum of the squares of all the elements in the array
RealT Sum() const: Returns the sum all elements of the array.
Slice1dC<RealT> Diagonal(): Take a slice along the diagonal of the array.
SArray1dC<RealT> SliceRow(IndexC i): Access row as 1d array.
NB. Changes made to the slice will also affect this array!
Slice1dC<RealT> 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<RealT> & 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<RealT> & val): Set the values in the row i to those in 'val'.
'val' must have a size equal to the number of columns
void BuildAccess(UIntT offset = 0,UIntT stride = 0)

#include "Ravl/SBfAcc.hh"

const SizeBufferAccessC<RealT> & operator =(RealT * bp): Changes the reference element to the element pointed by 'bp'. Access to the object --------------------
RealT * 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 RealT & operator [](const IndexC i) const: Read-only access to the ('i'+1)-th element of the buffer.
RealT & operator [](const IndexC i): Read-write access to the ('i'+1)-th element of the buffer.
const SizeBufferAccessC<RealT> & 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<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,SizeT size): Changes this buffer access to have the access rights as 'b' limited for 'size' elements.
SizeBufferAccessC<RealT> 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 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.
void Reverse(): Reverse the order of elements in this array in place.
SizeBufferAccessC<RealT> BufferFrom(UIntT first): Get an access for this buffer starting from the 'first' element to the end of the buffer.
SizeBufferAccessC<RealT> 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<RealT> & ba) const: Are two accesses the same ?
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.

#include "Ravl/SBfAcc2d.hh"

bool Contains(const Index2dC & i) const: Does this buffer contain the index i ?
Returns true if yes.
RealT & operator [](const Index2dC & i): access to the item array[(i)]
const RealT & operator [](const Index2dC & i) const: return the item array[(i)]
SizeBufferAccessC<RealT> operator [](IndexC i): access to the item array[(i)]
const SizeBufferAccessC<RealT> 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 RealT & 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/BufferAccess.hh"

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

#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:Kieron Messer, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002