libcrn  3.9.5
A document image processing library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Public Attributes | List of all members
crn::ClassifResult Class Reference

A generic classification result. More...

#include <CRNClassifResult.h>

+ Collaboration diagram for crn::ClassifResult:

Classes

class  SelectId
 Functor to select results in a container. More...
 

Public Member Functions

 ClassifResult ()
 Default constructor. More...
 
 ClassifResult (int cid, double dist, const SCObject &proto)
 Constructor from prototype. More...
 
 ClassifResult (int cid, const String &label, double dist, const SCObject &proto)
 Constructor from prototype and label. More...
 
 ClassifResult (const ClassifResult &)=default
 
 ClassifResult (ClassifResult &&)=default
 
ClassifResultoperator= (const ClassifResult &)=default
 
ClassifResultoperator= (ClassifResult &&)=default
 
bool operator< (const ClassifResult &cr) const noexcept
 Comparison operator. More...
 

Public Attributes

int class_id
 
String class_label
 
double distance
 
const SCObject prototype
 

Detailed Description

A generic classification result.

A generic classification result.

Author
Yann LEYDIER
Date
October 2008
Version
0.1

Definition at line 40 of file CRNClassifResult.h.

Constructor & Destructor Documentation

crn::ClassifResult::ClassifResult ( )
inline

Default constructor.

Definition at line 44 of file CRNClassifResult.h.

crn::ClassifResult::ClassifResult ( int  cid,
double  dist,
const SCObject &  proto 
)
inline

Constructor from prototype.

Constructor from prototype

Parameters
[in]cidthe class index
[in]distthe distance form the prototype to the object
[in]protothe protype

Definition at line 52 of file CRNClassifResult.h.

crn::ClassifResult::ClassifResult ( int  cid,
const String label,
double  dist,
const SCObject &  proto 
)
inline

Constructor from prototype and label.

Constructor from prototype and label

Parameters
[in]cidthe class index
[in]labelthe label of the class
[in]distthe distance form the prototype to the object
[in]protothe protype

Definition at line 61 of file CRNClassifResult.h.

crn::ClassifResult::ClassifResult ( const ClassifResult )
default
crn::ClassifResult::ClassifResult ( ClassifResult &&  )
default

Member Function Documentation

bool crn::ClassifResult::operator< ( const ClassifResult cr) const
inlinenoexcept

Comparison operator.

Comparison operator

Parameters
[in]crthe result to compare with
Returns
true if distance < cr.distance, false else

Definition at line 79 of file CRNClassifResult.h.

ClassifResult& crn::ClassifResult::operator= ( const ClassifResult )
default
ClassifResult& crn::ClassifResult::operator= ( ClassifResult &&  )
default

Member Data Documentation

int crn::ClassifResult::class_id

index of the class

Definition at line 68 of file CRNClassifResult.h.

String crn::ClassifResult::class_label

label of the class

Definition at line 69 of file CRNClassifResult.h.

double crn::ClassifResult::distance

distance from the prototype to the object

Definition at line 70 of file CRNClassifResult.h.

const SCObject crn::ClassifResult::prototype

prototype

Definition at line 71 of file CRNClassifResult.h.


The documentation for this class was generated from the following file: