Predictor.h File Reference

Predictor interface More...

#include "../Features/Feature.h"

Go to the source code of this file.

Classes

class  PredictorAlgorithm
class  Predictor
#define PREDICTOR_EXPORT   FEATURE_EXPORT
#define PREDICTOR_EXPORT_CLASS   FEATURE_EXPORT_CLASS

Defines

#define EXPORT_PREDICTOR(predictor)

Typedefs

typedef parametermap predictorparams
typedef vector< unsigned long > contexttrajectory
typedef PredictorAlgorithm *(* getPredictor_t )(const predictorparams &params)


Detailed Description

Predictor interface

© 2003-2004 by Rene Mayrhofer, Harald Radi

Date
2004-02-12 21:08:39 +0100 (Don, 12 Feb 2004)
Revision
612

Since:
Wed Mar 19 2003
Author:
Rene Mayrhofer <rene@mayrhofer.eu.org>

Harald Radi <harald.radi@nme.at>


This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Id
Predictor.h 612 2004-02-12 20:08:39Z harald

Define Documentation

#define EXPORT_PREDICTOR predictor   ) 
 

Value:

 \
        static predictor *pred; \
        void INIT_EXPORT library_initialize() { pred = NULL; } \
        void FINI_EXPORT library_finalize() { if (pred != NULL) delete pred; } \ \
        extern "C" PREDICTOR_EXPORT PredictorAlgorithm* getPredictor(predictorparams &params) { if (pred == NULL) pred = new predictor(params); return pred; }
Export a predictor

This macro has to be used in global scope and gets substituted with the implementation for exporting a PredictorAlgorithm singleton instance to the framework.

Parameters:
predictor The Class that implements the PredictorAlgorithm interface and should be exported to the framework.

#define PREDICTOR_EXPORT   FEATURE_EXPORT
 

compiler specific flags to export functions and classes


Typedef Documentation

typedef vector<unsigned long> contexttrajectory
 

Todo:
documentation

typedef PredictorAlgorithm*(* getPredictor_t)(const predictorparams &params)
 

Type of the getPredictor function

This type definition is needed by the Predictor Wrapper to query a PredictorAlgorithm implementation for an instance of its class.

typedef parametermap predictorparams
 

Parameters passed to predictors

When initializing a predictor, an arbitrary number of named (string) parameters can be passed from the application (e.g. read from a config file). These key-value tuples can then be used by the predictor as configuration or initialization values. They are completely predictor specific.

See also:
Predictor

PredictorAlgorithm


Generated on Mon Jun 5 10:20:48 2006 for Intelligence.kdevelop by  doxygen 1.4.6