User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Tuples - TFVectorC<class DataT,unsigned int N>
 

  PUBLIC
TFVectorC::TFVectorC(void)
TFVectorC::TFVectorC(const DataT *)
TFVectorC::TFVectorC(UIntT)
TFVectorC::Size(void) const
TFVectorC::Contains(UIntT) const
TFVectorC::operator [](UIntT)
TFVectorC::operator [](UIntT) const
TFVectorC::operator ==(const TFVectorC &) const
TFVectorC::operator !=(const TFVectorC &) const
TFVectorC::Fill(const DataT &)
TFVectorC::Abs(void) const
TFVectorC::operator +=(const TFVectorC &)
TFVectorC::operator -=(const TFVectorC &)
TFVectorC::operator *=(const TFVectorC &)
TFVectorC::operator /=(const TFVectorC &)
TFVectorC::operator +(const TFVectorC &) const
TFVectorC::operator -(const TFVectorC &) const
TFVectorC::operator *(const TFVectorC &) const
TFVectorC::operator /(const TFVectorC &) const
TFVectorC::operator -(void) const
TFVectorC::operator *=(const DataT &)
TFVectorC::operator /=(const DataT &)
TFVectorC::operator *(const DataT &) const
TFVectorC::operator /(const DataT &) const
TFVectorC::Dot(const TFVectorC &) const
TFVectorC::OuterProduct(const TFVectorC &,TFMatrixC &) const
TFVectorC::OuterProduct(TFMatrixC &) const
TFVectorC::Limit(const DataT &,const DataT &)
TFVectorC::MaxValueDistance(const TFVectorC &) const
TFVectorC::CityBlockDistance(const TFVectorC &) const
TFVectorC::SqrEuclidDistance(const TFVectorC &) const
TFVectorC::Sum(void) const
TFVectorC::SumSqr(void) const
TFVectorC::T(void) const
TFVectorC::operator >>(istream &,TFVectorC &)
TFVectorC::operator <<(ostream &,const TFVectorC &)
TFVectorC::operator >>(BinIStreamC &,TFVectorC &)
TFVectorC::operator <<(BinOStreamC &,const TFVectorC &)

   TFVectorC<class DataT,unsigned int N>   
 
Fixed size vector.
 
include "Ravl/TFVector.hh"
Created:24/01/2001 
User Level:Advanced
Library:RavlCore
In Scope:RavlN

Derived Classes: Variables:
Methods:
TFVectorC()
Default constructor.
Note: The default constructor of 'DataT' is used to contruct the elements of the vector, for builtin types this means their values will be undefined.

TFVectorC(const DataT * init)
Value constructor.
Copy values from 'init'. It is the user's responsibility to ensure that data has at least 'N' elements.

TFVectorC(UIntT size)
This constructor is for compatibility with arbitrarily sized vectors.
Used by some templates.

UIntT Size() const
Get size of array
Used by some templates.

bool Contains(UIntT i) const
Test if array contains index i

DataT & operator [](UIntT ind)
Access item.

const DataT & operator [](UIntT ind) const
Access item.

bool operator ==(const TFVectorC<DataT,N> & ind) const
is equal

bool operator !=(const TFVectorC<DataT,N> & ind) const
is not equal

void Fill(const DataT & dat)
Fill array with value 'dat'.

TFVectorC<DataT,N> Abs() const
Get an vector with Abs(x) run on all it values.

const TFVectorC<DataT,N> & operator +=(const TFVectorC<DataT,N> & ind)
Add an array to this one, inplace.

const TFVectorC<DataT,N> & operator -=(const TFVectorC<DataT,N> & ind)
Returns this index multiplied by index 'ind' item by item.

const TFVectorC<DataT,N> & operator *=(const TFVectorC<DataT,N> & ind)
Multiplies this index by index 'ind' item by item.

const TFVectorC<DataT,N> & operator /=(const TFVectorC<DataT,N> & ind)
Divides this index by index 'ind' item by item.

TFVectorC<DataT,N> operator +(const TFVectorC<DataT,N> & ind) const
Adds this index and 'ind'.

TFVectorC<DataT,N> operator -(const TFVectorC<DataT,N> & ind) const
Subtracts index 'ind' from this index.

TFVectorC<DataT,N> operator *(const TFVectorC<DataT,N> & ind) const
Returns this object multiplied by index 'ind' item by item.

TFVectorC<DataT,N> operator /(const TFVectorC<DataT,N> & ind) const
Returns this object devided by index 'ind' item by item.

TFVectorC<DataT,N> operator -() const
Returns opposite elements (unary minus operator).

const TFVectorC<DataT,N> & operator *=(const DataT & alpha)
Multiplies this index by number 'alpha'.

const TFVectorC<DataT,N> & operator /=(const DataT & alpha)
Divides this index by number 'alpha'.

TFVectorC<DataT,N> operator *(const DataT & alpha) const
Returns this object mutliplied by alpha.

TFVectorC<DataT,N> operator /(const DataT & alpha) const
Returns this object devided by alpha.

DataT Dot(const TFVectorC<DataT,N> & oth) const
Calculate the dot product of this and 'oth' vector.

TFMatrixC<DataT,N,N> & OuterProduct(const TFVectorC<DataT,N> & av,TFMatrixC<DataT,N,N> & result) const
Calculate the outer product of this vector with av.
The output is assigned to 'result'. A reference to 'result' is returned.

The implementation is in "Ravl/FMatrix.hh", it must be included to use this function.


TFMatrixC<DataT,N,N> & OuterProduct(TFMatrixC<DataT,N,N> & result) const
Calculate the outer product of this vector with itsself.
The output is assigned to 'result'. A reference to 'result' is returned.

The implementation is in "Ravl/FMatrix.hh", it must be included to use this function.


bool Limit(const DataT & min,const DataT & max)
Limit all values in this vector to between min and max.
Returns true if all values in the vector are between the limits. Distance calculations ---------------------

DataT MaxValueDistance(const TFVectorC<DataT,N> & i) const
Returns the distance of two indexes in maximum value metric.

DataT CityBlockDistance(const TFVectorC<DataT,N> & i) const
Returns the distance of two indexes in absolute value metric.

DataT SqrEuclidDistance(const TFVectorC<DataT,N> & i) const
Returns the distance of two indexes in square Euclid metric.

DataT Sum() const
Calculate the sum of all the vector elements.

DataT SumSqr() const
Calculate the sum of the squares of all the vector elements.

const TFMatrixC<DataT,1,N> & T() const
Transpose vector.
The implementation for this can be found in "Ravl/TFMatrix.hh"

istream & operator >>(istream & in,TFVectorC<DataT,N> & dat)

ostream & operator <<(ostream & in,const TFVectorC<DataT,N> & dat)

BinIStreamC & operator >>(BinIStreamC & in,TFVectorC<DataT,N> & dat)

BinOStreamC & operator <<(BinOStreamC & in,const TFVectorC<DataT,N> & dat)


Maintainer:Charles Galambos, Created: 24/01/2001, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002