#include <MultidimensionalRegression.h>

Inheritance diagram for MultidimensionalRegression:

Public Member Functions
	MultidimensionalRegression (const Regressifier &regressifier=LinearRegression(), bool useScaling=false)

virtual	~MultidimensionalRegression (void)

MultidimensionalRegression &	operator= (const MultidimensionalRegression &rhs)

virtual bool	deepCopyFrom (const Regressifier *regressifier)

virtual bool	train_ (RegressionData &trainingData)

virtual bool	predict_ (VectorFloat &inputVector)

virtual bool	save (std::fstream &file) const

virtual bool	load (std::fstream &file)

bool	getIsRegressionModuleSet () const

Regressifier *	getRegressifier () const

bool	setRegressionModule (const Regressifier &regressifier)

Public Member Functions inherited from Regressifier
	Regressifier (void)

virtual	~Regressifier (void)

bool	copyBaseVariables (const Regressifier *regressifier)

virtual bool	reset ()

virtual bool	clear ()

std::string	getRegressifierType () const

VectorFloat	getRegressionData () const

Vector< MinMax >	getInputRanges () const

Vector< MinMax >	getOutputRanges () const

Regressifier *	createNewInstance () const

Regressifier *	deepCopy () const

const Regressifier &	getBaseRegressifier () const

Public Member Functions inherited from MLBase
	MLBase (void)

virtual	~MLBase (void)

bool	copyMLBaseVariables (const MLBase *mlBase)

virtual bool	train (ClassificationData trainingData)

virtual bool	train_ (ClassificationData &trainingData)

virtual bool	train (RegressionData trainingData)

virtual bool	train (TimeSeriesClassificationData trainingData)

virtual bool	train_ (TimeSeriesClassificationData &trainingData)

virtual bool	train (ClassificationDataStream trainingData)

virtual bool	train_ (ClassificationDataStream &trainingData)

virtual bool	train (UnlabelledData trainingData)

virtual bool	train_ (UnlabelledData &trainingData)

virtual bool	train (MatrixFloat data)

virtual bool	train_ (MatrixFloat &data)

virtual bool	predict (VectorFloat inputVector)

virtual bool	predict (MatrixFloat inputMatrix)

virtual bool	predict_ (MatrixFloat &inputMatrix)

virtual bool	map (VectorFloat inputVector)

virtual bool	map_ (VectorFloat &inputVector)

virtual bool	print () const

virtual bool	save (const std::string filename) const

virtual bool	load (const std::string filename)

	GRT_DEPRECATED_MSG ("saveModelToFile(std::string filename) is deprecated, use save(std::string filename) instead", virtual bool saveModelToFile(std::string filename) const )

	GRT_DEPRECATED_MSG ("saveModelToFile(std::fstream &file) is deprecated, use save(std::fstream &file) instead", virtual bool saveModelToFile(std::fstream &file) const )

	GRT_DEPRECATED_MSG ("loadModelFromFile(std::string filename) is deprecated, use load(std::string filename) instead", virtual bool loadModelFromFile(std::string filename))

	GRT_DEPRECATED_MSG ("loadModelFromFile(std::fstream &file) is deprecated, use load(std::fstream &file) instead", virtual bool loadModelFromFile(std::fstream &file))

virtual bool	getModel (std::ostream &stream) const

Float	scale (const Float &x, const Float &minSource, const Float &maxSource, const Float &minTarget, const Float &maxTarget, const bool constrain=false)

virtual std::string	getModelAsString () const

DataType	getInputType () const

DataType	getOutputType () const

UINT	getBaseType () const

UINT	getNumInputFeatures () const

UINT	getNumInputDimensions () const

UINT	getNumOutputDimensions () const

UINT	getMinNumEpochs () const

UINT	getMaxNumEpochs () const

UINT	getValidationSetSize () const

UINT	getNumTrainingIterationsToConverge () const

Float	getMinChange () const

Float	getLearningRate () const

Float	getRootMeanSquaredTrainingError () const

Float	getTotalSquaredTrainingError () const

Float	getValidationSetAccuracy () const

VectorFloat	getValidationSetPrecision () const

VectorFloat	getValidationSetRecall () const

bool	getUseValidationSet () const

bool	getRandomiseTrainingOrder () const

bool	getTrained () const

bool	getModelTrained () const

bool	getScalingEnabled () const

bool	getIsBaseTypeClassifier () const

bool	getIsBaseTypeRegressifier () const

bool	getIsBaseTypeClusterer () const

bool	enableScaling (const bool useScaling)

bool	setMaxNumEpochs (const UINT maxNumEpochs)

bool	setMinNumEpochs (const UINT minNumEpochs)

bool	setMinChange (const Float minChange)

bool	setLearningRate (const Float learningRate)

bool	setUseValidationSet (const bool useValidationSet)

bool	setValidationSetSize (const UINT validationSetSize)

bool	setRandomiseTrainingOrder (const bool randomiseTrainingOrder)

bool	setTrainingLoggingEnabled (const bool loggingEnabled)

bool	registerTrainingResultsObserver (Observer< TrainingResult > &observer)

bool	registerTestResultsObserver (Observer< TestInstanceResult > &observer)

bool	removeTrainingResultsObserver (const Observer< TrainingResult > &observer)

bool	removeTestResultsObserver (const Observer< TestInstanceResult > &observer)

bool	removeAllTrainingObservers ()

bool	removeAllTestObservers ()

bool	notifyTrainingResultsObservers (const TrainingResult &data)

bool	notifyTestResultsObservers (const TestInstanceResult &data)

MLBase *	getMLBasePointer ()

const MLBase *	getMLBasePointer () const

Vector< TrainingResult >	getTrainingResults () const

Public Member Functions inherited from GRTBase
	GRTBase (void)

virtual	~GRTBase (void)

bool	copyGRTBaseVariables (const GRTBase *GRTBase)

std::string	getClassType () const

std::string	getLastWarningMessage () const

std::string	getLastErrorMessage () const

std::string	getLastInfoMessage () const

bool	setInfoLoggingEnabled (const bool loggingEnabled)

bool	setWarningLoggingEnabled (const bool loggingEnabled)

bool	setErrorLoggingEnabled (const bool loggingEnabled)

GRTBase *	getGRTBasePointer ()

const GRTBase *	getGRTBasePointer () const

Public Member Functions inherited from Observer< TrainingResult >
virtual void	notify (const TrainingResult &data)

Public Member Functions inherited from Observer< TestInstanceResult >
virtual void	notify (const TestInstanceResult &data)

Protected Member Functions
bool	deepCopyRegressionModules (Vector< Regressifier * > &newModules) const

bool	deleteAll ()

bool	deleteRegressionModules ()

bool	loadLegacyModelFromFile (std::fstream &file)

Protected Member Functions inherited from Regressifier
bool	saveBaseSettingsToFile (std::fstream &file) const

bool	loadBaseSettingsFromFile (std::fstream &file)

Protected Member Functions inherited from MLBase
bool	saveBaseSettingsToFile (std::fstream &file) const

bool	loadBaseSettingsFromFile (std::fstream &file)

Protected Member Functions inherited from GRTBase
Float	SQR (const Float &x) const

Protected Attributes
Regressifier *	regressifier

Vector< Regressifier * >	regressionModules

Protected Attributes inherited from Regressifier
std::string	regressifierType

VectorFloat	regressionData

Vector< MinMax >	inputVectorRanges

Vector< MinMax >	targetVectorRanges

Protected Attributes inherited from MLBase
bool	trained

bool	useScaling

DataType	inputType

DataType	outputType

UINT	baseType

UINT	numInputDimensions

UINT	numOutputDimensions

UINT	numTrainingIterationsToConverge

UINT	minNumEpochs

UINT	maxNumEpochs

UINT	validationSetSize

Float	learningRate

Float	minChange

Float	rootMeanSquaredTrainingError

Float	totalSquaredTrainingError

Float	validationSetAccuracy

bool	useValidationSet

bool	randomiseTrainingOrder

VectorFloat	validationSetPrecision

VectorFloat	validationSetRecall

Random	random

std::vector< TrainingResult >	trainingResults

TrainingResultsObserverManager	trainingResultsObserverManager

TestResultsObserverManager	testResultsObserverManager

Protected Attributes inherited from GRTBase
std::string	classType

DebugLog	debugLog

ErrorLog	errorLog

InfoLog	infoLog

TrainingLog	trainingLog

TestingLog	testingLog

WarningLog	warningLog

Static Protected Attributes
static RegisterRegressifierModule< MultidimensionalRegression >	registerModule

Additional Inherited Members
Public Types inherited from Regressifier
typedef std::map< std::string, Regressifier ()() >	StringRegressifierMap

Public Types inherited from MLBase
enum	BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER }

Static Public Member Functions inherited from Regressifier
static Regressifier *	createInstanceFromString (const std::string &regressifierType)

static Vector< std::string >	getRegisteredRegressifiers ()

Static Public Member Functions inherited from GRTBase
static std::string	getGRTVersion (bool returnRevision=true)

static std::string	getGRTRevison ()

Static Protected Member Functions inherited from Regressifier
static StringRegressifierMap *	getMap ()

Detailed Description

GRT MIT License Copyright (c) <2012> <Nicholas Gillian, Media Lab, MIT>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition at line 47 of file MultidimensionalRegression.h.

Constructor & Destructor Documentation

MultidimensionalRegression::MultidimensionalRegression	(	const Regressifier &	regressifier = `LinearRegression()`,
		bool	useScaling = `false`
	)

Default Constructor

Parameters

useScaling sets if the training and real-time data should be scaled between [0 1]. Default value = false

Definition at line 29 of file MultidimensionalRegression.cpp.

MultidimensionalRegression::~MultidimensionalRegression ( void )

virtual

Default Destructor

Definition at line 42 of file MultidimensionalRegression.cpp.

Member Function Documentation

bool MultidimensionalRegression::deepCopyFrom ( const Regressifier * regressifier )

virtual

This is required for the Gesture Recognition Pipeline for when the pipeline.setRegressifier(...) method is called. It clones the data from the Base Class Regressifier pointer (which should be pointing to an Multidimensional Regressioninstance) into this instance

Parameters

regressifier a pointer to the Regressifier Base Class, this should be pointing to another Multidimensional Regression instance

Returns: returns true if the clone was successfull, false otherwise

Reimplemented from Regressifier.

Definition at line 68 of file MultidimensionalRegression.cpp.

bool MultidimensionalRegression::getIsRegressionModuleSet ( ) const

This returns true if the regression module has been set. The regression module is the regression algorithm that will be used when the user attempts to train N regression models.

A regression module must be set before a regression model can be trained.

Returns: returns true if the regression module has been set, false otherwise

Definition at line 321 of file MultidimensionalRegression.cpp.

Regressifier * MultidimensionalRegression::getRegressifier ( ) const

This returns a pointer to the regression module. If no regression module has been set, then this function will return NULL.

Returns: returns a pointer to the regression module if it has been set, or NULL otherwise

Definition at line 325 of file MultidimensionalRegression.cpp.

bool MultidimensionalRegression::load ( std::fstream & file )

virtual

This loads a trained Multidimensional Regression model from a file. This overrides the load function in the ML base class.

Parameters

file	a reference to the file the Logistic Regression model will be loaded from

Returns: returns true if the model was loaded successfully, false otherwise

Reimplemented from MLBase.

Definition at line 246 of file MultidimensionalRegression.cpp.

bool MultidimensionalRegression::loadLegacyModelFromFile ( std::fstream & file )

protected

Read the ranges if needed

Definition at line 397 of file MultidimensionalRegression.cpp.

MultidimensionalRegression & MultidimensionalRegression::operator= ( const MultidimensionalRegression & rhs )

Defines how the data from the rhs MultidimensionalRegression should be copied to this MultidimensionalRegression

Parameters

rhs	another instance of a MultidimensionalRegression

Returns: returns a pointer to this instance of the MultidimensionalRegression

Definition at line 47 of file MultidimensionalRegression.cpp.

bool MultidimensionalRegression::predict_ ( VectorFloat & inputVector )

virtual

This performs the regression by mapping the inputVector using the current Multidimensional Regression model. This overrides the predict function in the ML base class.

Parameters

inputVector the input Vector to classify

Returns: returns true if the prediction was performed, false otherwise

Reimplemented from MLBase.

Definition at line 170 of file MultidimensionalRegression.cpp.

bool MultidimensionalRegression::save ( std::fstream & file ) const

virtual

This saves the trained Multidimensional Regression model to a file. This overrides the save function in the ML base class.

Parameters

file	a reference to the file the Multidimensional Regression model will be saved to

Returns: returns true if the model was saved successfully, false otherwise

Reimplemented from MLBase.

Definition at line 206 of file MultidimensionalRegression.cpp.

bool MultidimensionalRegression::setRegressionModule ( const Regressifier & regressifier )

Sets the regression module that will be used the next time a user attempts to train a regression module.

Parameters

regressifier a reference to a regression module that will be copied and used the next time the user attempts to train a regression module

Returns: returns true if the regresion module was set successfully, false otherwise

Definition at line 329 of file MultidimensionalRegression.cpp.

bool MultidimensionalRegression::train_ ( RegressionData & trainingData )

virtual

This trains the Multidimensional Regression model, using the labelled regression data. This overrides the train function in the ML base class.

Parameters

trainingData the training data that will be used to train the regression model

Returns: returns true if the Multidimensional Regression model was trained, false otherwise

Reimplemented from MLBase.

Definition at line 92 of file MultidimensionalRegression.cpp.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation