Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
NumLabelC::NumLabelC(void)
NumLabelC::NumLabelC(UIntT)
NumLabelC::NumLabelC(istream &)
NumLabelC::NumLabelC(const VectorC &)
NumLabelC::NumLabelC(const NumLabelC &)
NumLabelC::operator==(const NumLabelC &) const
NumLabelC::operator!=(const NumLabelC &) const
NumLabelC::Copy(void) const
NumLabelC::Save(ostream &) const
NumLabelC::LessOrEqual(const NumLabelC &) const
NumLabelC::AsIndex(void) const
NumLabelC::AsUIntT(void) const
NumLabelC::SetInvalid(void)
NumLabelC::IsInvalid(void) const
NumLabelC::Hash(void) const
NumLabelC::MaxOf(UIntT) const
NumLabelC::LabelToVec(const NumLabelC &,UIntT,RealT,RealT)
NumLabelC
 
Represents class labels for classification in PatternRec.
 
include "amma/Num/NumLabel.hh"
User Level:Default
Library:NumData
Example:testSquareIterFill.cc
Section:Pattern Recognition.Data Types Numerical Methods.Data Types
In Scope:std

Comments:
Class for representing class labels for classification. Slightly limited approach means that they are assumed to be incrementing unsigned integers but this is required to facilitate access to a vector of corresponding class probabilities.

Base class in the PatternRec hierarchy and is used in conjunction with classification objects derived from NumClassifyC for representing class labels.

Variables:
UIntT _label;

Methods:
NumLabelC()
Default constructor
Label value is undefined.

NumLabelC(UIntT label)
Constructor with label value

NumLabelC(istream & in)
Constructs from stream

NumLabelC(const VectorC & oth)
Constructs from probability vector
Converts from vector to label using VecToLabel.

NumLabelC(const NumLabelC & oth)
Copy constructor

BooleanT operator==(const NumLabelC & oth) const
Equality operator

BooleanT operator!=(const NumLabelC & oth) const
Inequality operator

NumLabelC Copy() const
Makes a copy, needed for containers

void Save(ostream & out) const
Writes object to stream, can be loaded using constructor

int LessOrEqual(const NumLabelC & oth) const
Compares two labels, used for sorting

IndexT AsIndex() const
Treats label as an index for accessing probability vectors

UIntT AsUIntT() const
Converts label to unsigned integer

void SetInvalid()
Set this label to an invalid value.

BooleanT IsInvalid() const
Is this an invalid label ?

UIntT Hash() const
Get hash value for label.

UIntT MaxOf(UIntT val) const
Returns maximum of current label and val

VectorC LabelToVec(const NumLabelC & L,UIntT maxLabel,RealT minP = 0.0,RealT maxP = 1.0)


Programmer:Robert Crida, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001