User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Indexing - FIndexC<unsigned int N>
 

  PUBLIC
FIndexC::FIndexC(void)
FIndexC::FIndexC(const TFVectorC &)
FIndexC::FIndexC(SizeT)
FIndexC::Hash(void) const
FIndexC::operator *=(IntT)
FIndexC::operator *=(RealT)
FIndexC::operator /=(IntT)
FIndexC::operator /=(RealT)
FIndexC::operator *(IntT) const
FIndexC::operator *(RealT) const
FIndexC::operator /(IntT) const
FIndexC::operator /(RealT) const
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 &)

   FIndexC<unsigned int N>   
 
Fixed sized Index
 
include "Ravl/FIndex.hh"
Created:24/01/2001 
User Level:Advanced
Library:RavlCore
In Scope:RavlN

Parent Classes: Derived Classes: Methods:
FIndexC()
Default constructor.

FIndexC(const TFVectorC<IndexC,N> & oth)
Base class constructor.

FIndexC(SizeT dim)
Constructor with requested size.

UIntT Hash(void) const
Generates a randomised hash value for this index.

Arithmetic operations

const FIndexC<N> & operator *=(IntT alpha)
Multiplies this index by number 'alpha'.

const FIndexC<N> & operator *=(RealT alpha)
Multiplies this index by real number 'alpha'.

const FIndexC<N> & operator /=(IntT alpha)
Divides this index by number 'alpha'.

const FIndexC<N> & operator /=(RealT alpha)
Divides this index by real number 'alpha'.

FIndexC<N> operator *(IntT alpha) const
Multiplies this index by number 'alpha'.

FIndexC<N> operator *(RealT alpha) const
Multiplies this index by real number 'alpha'.

FIndexC<N> operator /(IntT alpha) const
Divides this index by number 'alpha'.

FIndexC<N> operator /(RealT alpha) const
Divides this index by real number 'alpha'.

#include "Ravl/TFVector.hh"
UIntT Size() const
Get size of array
Used by some templates.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TFMatrixC<IndexC,N,N> & OuterProduct(const TFVectorC<IndexC,N> & av,TFMatrixC<IndexC,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<IndexC,N,N> & OuterProduct(TFMatrixC<IndexC,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 IndexC & min,const IndexC & 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 ---------------------

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

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

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

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

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

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

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

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

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

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


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