Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Pattern Recognition - Data Set - SampleC<class DataT>
 

  PUBLIC
SampleC::SampleC(SizeT)
SampleC::SampleC(const SArray1dC &)
SampleC::SubSample(const CollectionC &)
SampleC::ExtractEntry(int)
SampleC::Append(const DataT &)
SampleC::operator +=(const DataT &)
SampleC::Size(void) const
SampleC::PickElement(UIntT)
SampleC::Nth(UIntT)
SampleC::Nth(UIntT) const
SampleC::Pick(void)
SampleC::operator [](IndexC)
SampleC::operator [](IndexC) const
SampleC::DArray(void)
SampleC::DArray(void) const
SampleC::First(void)
SampleC::First(void) const
SampleC::Last(void)
SampleC::Last(void) const
SampleC::IsEmpty(void) const
DArray1dC::Copy(void) const
DArray1dC::Index(IndexC)
DArray1dC::Index(IndexC) const
DArray1dC::Nth(UIntT)
DArray1dC::Nth(UIntT) const
DArray1dC::operator [](IndexC)
DArray1dC::operator [](IndexC) const
DArray1dC::Append(const Array1dC &)
DArray1dC::Append(const DArray1dC &)
DArray1dC::Append(const DataT &)
DArray1dC::Remove(IndexC)
DArray1dC::Remove(IndexC,IndexC)
DArray1dC::RemoveFirst(void)
DArray1dC::RemoveLast(void)
DArray1dC::Contains(IndexC) const
DArray1dC::Fill(const DataT &)
DArray1dC::Range(void) const
DArray1dC::IMax(void) const
DArray1dC::IMin(void) const
DArray1dC::IsEmpty(void) const
DArray1dC::Empty(void)
DArray1dC::Size(void) const
DArray1dC::First(void)
DArray1dC::First(void) const
DArray1dC::Last(void)
DArray1dC::Last(void) const
RCHandleC::operator =(const RCHandleC &)
RCHandleC::DeepCopy(UIntT) const
RCHandleC::operator ==(const RCHandleC &) const
RCHandleC::operator !=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsValid(void) const
RCHandleC::Invalidate(void)
RCHandleC::IsHandleType(const DT &) const
RCHandleC::CheckHandleType(const DT &) const
RCHandleC::Body(void)
RCHandleC::Body(void) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

   SampleC<class DataT>   
 
Sample of DataT's
 
include "Ravl/PatternRec/Sample.hh"
Source file:Ravl/PatternRec/DataSet/Sample.hh
User Level:Normal
Library:RavlPatternRec
In Scope:RavlN

Parent Classes: Derived Classes: Typedefs:
typedef DataT ElementT;
Type of data in sample.

Methods:
SampleC(SizeT maxSize = 10)
Create a sample of data with a maximum size

SampleC(const SArray1dC<DataT> & dat)
Create a sample of data from an array

SampleC<DataT> SubSample(const CollectionC<UIntT> & x)
Take a subsample of the given indexes in x.

DataT ExtractEntry(int ind)
Extract an entry from sample.

UIntT Append(const DataT & dat)
Insert a single sample into sample

UIntT operator +=(const DataT & dat)
Indentical to Append().

SizeT Size() const
Return the number of valid samples in the collection

DataT PickElement(UIntT i)
Pick a item i from the collection
Note: The order of the collection is NOT preserved. This minimizes the distruption to the underlying representation by removing an element from the end of the array and placing it in the hole left by removing 'i'.

DataT & Nth(UIntT i)
Access nth element in sample.

const DataT & Nth(UIntT i) const
Access nth element in sample.

DataT Pick()
Pick a random item from the collection
Note: The order of the collection is NOT preserved.

DataT & operator [](IndexC ind)
Access a sample.

const DataT & operator [](IndexC ind) const
Access a sample.

DArray1dC<DataT> & DArray()
Access DArray.
For internal use only.

const DArray1dC<DataT> & DArray() const
Access DArray.
For internal use only.

DataT & First()
Access first element in the array.

const DataT & First() const
Access first element in the array.

DataT & Last()
Access last element in the array.

const DataT & Last() const
Access last element in the array.

bool IsEmpty() const
Is this empty ?

#include "Ravl/DArray1d.hh"
DArray1dC<DataT> Copy() const
Make a copy of this DArray.

DataT & Index(IndexC i)
Find data item with that index.

const DataT & Index(IndexC i) const
Find data item with that index.

DataT & Nth(UIntT i)
Find the n'th entry, irrespective of index values.

const DataT & Nth(UIntT i) const
Find the n'th entry, irrespective of index values.

DataT & operator [](IndexC i)
Access element.

const DataT & operator [](IndexC i) const
Access element.

UIntT Append(const Array1dC<DataT> & newData)
Append data to this array.
Note the data is not copied! The number of items appended is returned.

UIntT Append(const DArray1dC<DataT> & newData)
Append data to this array.
Note the data is not copied! The number of items appended is returned.

IndexC Append(const DataT & newData)
Append data to this array.
Returns index of new item.

bool Remove(IndexC i)
Remove single entry from the array.

bool Remove(IndexC min,IndexC max)
Remove entries from min to max from the array.
This removes entries from min to max inclusively from the array.

bool RemoveFirst()
Remove first element from the array.

bool RemoveLast()
Remove last element from the array.

bool Contains(IndexC i) const
Test if container contains index.

void Fill(const DataT & value)
Fill array with given value.

IndexRangeC Range() const
Get range of indexes covered by array.
Note, there may be holes in the range.

IndexC IMax() const
Maximum offset used.
If range is empty the results are undefined.

IndexC IMin() const
Minimum offset used.
If range is empty the results are undefined.

bool IsEmpty() const
Is array empty ?

void Empty()
Empty this array of all its contents.

UIntT Size() const
Find the number of elements in the DArray.
This doesn't count holes in the array.

DataT & First()
Access first element in the array.

const DataT & First() const
Access first element in the array.

DataT & Last()
Access last element in the array.

const DataT & Last() const
Access last element in the array.

#include "Ravl/RefCounter.hh"
const RCHandleC<DArray1dBodyC<DataT>> & operator =(const RCHandleC<DArray1dBodyC<DataT>> & oth)
Assign handle.

RCHandleC<DArray1dBodyC<DataT>> DeepCopy(UIntT levels = ((UIntT))) const
Do a deep copy of the object.

bool operator ==(const RCHandleC<DArray1dBodyC<DataT>> & oth) const
Are handles to the same object ?

bool operator !=(const RCHandleC<DArray1dBodyC<DataT>> & oth) const
Are handles to different objects ?

UIntT Hash() const
Default hash function.
This hashes on the address of the body.

bool IsValid() const
Test if this is a valid handle.

void Invalidate()
Invalidate this handle.
Unattaches the body from the handle.

bool IsHandleType(const DT &) const
Is handle of given type ?

void CheckHandleType(const DT & dummy) const
Check handle type. Throw an expception if not.

DArray1dBodyC<DataT> & Body()
Access body of object.

const DArray1dBodyC<DataT> & Body() const
Constant access to body of object.

UIntT References() const
Find the number of references to the body of this object.

ostream & operator <<(ostream & strm,const RCHandleC<DArray1dBodyC<DataT>> & obj)

istream & operator >>(istream & strm,RCHandleC<DArray1dBodyC<DataT>> & obj)


Maintainer:Kieron Messer, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002