Regressifier.h

Go to the documentation of this file.

#ifndef GRT_REGRESSIFIER_HEADER
#define GRT_REGRESSIFIER_HEADER

#include "MLBase.h"
#include "../DataStructures/ClassificationData.h"
#include "../DataStructures/TimeSeriesClassificationData.h"

GRT_BEGIN_NAMESPACE
    
#define DEFAULT_NULL_LIKELIHOOD_VALUE 0
#define DEFAULT_NULL_DISTANCE_VALUE 0

class Regressifier : public MLBase
{
public:
 Regressifier(void);
    
 virtual ~Regressifier(void);
    
    virtual bool deepCopyFrom(const Regressifier *regressifier){ return false; }
    
    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;
    
    typedef std::map< std::string, Regressifier*(*)() > StringRegressifierMap;

    static Regressifier* createInstanceFromString( const std::string &regressifierType );

    Regressifier* createNewInstance() const;
    
    Regressifier* deepCopy() const;
    
    const Regressifier& getBaseRegressifier() const;
    
 static Vector< std::string > getRegisteredRegressifiers();
 
 //Tell the compiler we are explicitly using the following classes from the base class (this stops hidden overloaded virtual function warnings)
    using MLBase::train;
    
protected:
    bool saveBaseSettingsToFile( std::fstream &file ) const;
    
    bool loadBaseSettingsFromFile( std::fstream &file );

    std::string regressifierType;
    VectorFloat regressionData;
    Vector< MinMax > inputVectorRanges;
 Vector< MinMax > targetVectorRanges;
    
    static StringRegressifierMap *getMap() {
        if( !stringRegressifierMap ){ stringRegressifierMap = new StringRegressifierMap; } 
        return stringRegressifierMap; 
    }
    
private:
    static StringRegressifierMap *stringRegressifierMap;
    static UINT numRegressifierInstances;

};
    
//These two functions/classes are used to register any new Regression Module with the Regressifier base class
template< typename T >  Regressifier *newRegressionModuleInstance() { return new T; }

template< typename T > 
class RegisterRegressifierModule : public Regressifier { 
public:
    RegisterRegressifierModule( const std::string &newRegresionModuleName ) { 
        getMap()->insert( std::pair< std::string, Regressifier*(*)() >(newRegresionModuleName, &newRegressionModuleInstance< T > ) );
    }
};

GRT_END_NAMESPACE

#endif //GRT_REGRESSIFIER_HEADER