Measures. More...
#include <gmeasure.h>
Public Member Functions | |
GMeasure (GSession *session, GPlugInFactory *fac) | |
virtual void | Measure (size_t measure,...)=0 |
virtual void | Info (size_t info,...) |
virtual | ~GMeasure (void) |
Public Member Functions inherited from GPlugIn | |
GPlugIn (GSession *session, GPlugInFactory *fac) | |
virtual void | ApplyConfig (void) |
void | InsertParam (R::RParam *param) |
template<class T > | |
T * | FindParam (const R::RString &name) |
R::RCursor< R::RParam > | GetParams (const R::RString &cat=R::RString::Null) |
void | GetCategories (R::RContainer< R::RString, true, false > &cats) |
virtual void | Init (void) |
virtual void | CreateConfig (void) |
virtual void | Reset (void) |
GPlugInFactory * | GetFactory (void) const |
int | Compare (const GPlugIn &plugin) const |
int | Compare (const R::RString &plugin) const |
R::RString | GetName (void) const |
R::RString | GetDesc (void) const |
GSession * | GetSession (void) const |
virtual void | Done (void) |
virtual | ~GPlugIn (void) |
Additional Inherited Members | |
Protected Attributes inherited from GPlugIn | |
GPlugInFactory * | Factory |
GSession * | Session |
size_t | Id |
Detailed Description
Measures.
The GMeasure class provides a representation for a specific measure (ex: Similarities between profiles, similarities between documents and groups, agreement ratios between profiles, ...).
See the documentation related to GPlugIn for more general information.
Constructor & Destructor Documentation
GMeasure | ( | GSession * | session, |
GPlugInFactory * | fac | ||
) |
Constructor of a measure.
- Parameters
-
session Session. fac Plug-in factory.
|
virtual |
Destruct the measure.
Member Function Documentation
|
pure virtual |
Get a measure. Each plug-in can handle several types of measure (first parameter of the method). The other parameters (including eventually the result of the measure) depend of the particular plug-in. This means that the caller must exactly know which parameters are requested by a particular plug-in. This method is intended to be called in an intensive way (in contrary of Info)
- Parameters
-
measure Type of the measure.
Suppose that the method takes two int arguments and should return a double that represents the product (measure=1) or the sum (measure=2). This method should be written:
The method should be call:
Implemented in GMatrixMeasure.
|
virtual |
Exchange a particular information with the plug-in. The other parameters (including eventually the result of the measure) depend of the particular plug-in. This means that the caller must exactly know which parameters are requested by a particular plug-in. This method is not intended to be called in an intensive way (in contrary of Measure).
- Parameters
-
info Information to get.
Suppose the function should simply return a double. This method should be written:
The method should be call:
Reimplemented in GMatrixMeasure.