Clusterer.h

Go to the documentation of this file.

#ifndef GRT_CLUSTERER_HEADER
#define GRT_CLUSTERER_HEADER

#include "MLBase.h"

GRT_BEGIN_NAMESPACE

class GRT_API Clusterer : public MLBase
{
public:
 Clusterer( const std::string &id = "" );
 
 virtual ~Clusterer(void);
 
 virtual bool deepCopyFrom(const Clusterer *clusterer){ return false; }
 
 bool copyBaseVariables(const Clusterer *clusterer);
 
 virtual bool train_(MatrixFloat &trainingData) override;
 
 virtual bool train_(ClassificationData &trainingData) override;
 
 virtual bool train_(UnlabelledData &trainingData) override;
 
 virtual bool reset() override;
 
 virtual bool clear() override;
 
 UINT getNumClusters() const;
 
 UINT getPredictedClusterLabel() const;
 
 Float getMaximumLikelihood() const;
 
 Float getBestDistance() const;
 
 VectorFloat getClusterLikelihoods() const;
 
 VectorFloat getClusterDistances() const;
 
 Vector< UINT > getClusterLabels() const;

 GRT_DEPRECATED_MSG( "getClustererType() is deprecated, use getId() or getBaseId() instead", std::string getClustererType() const );
 
 bool setNumClusters(const UINT numClusters);
 
 typedef std::map< std::string, Clusterer*(*)() > StringClustererMap;
 
 static Clusterer* create( std::string const &id );
 
 Clusterer* create() const;

 GRT_DEPRECATED_MSG( "createNewInstance is deprecated, use create instead.", Clusterer* createNewInstance() const );
 GRT_DEPRECATED_MSG( "createInstanceFromString is deprecated, use create instead.", static Clusterer* createInstanceFromString( const std::string &id ) );
 
 Clusterer* deepCopy() const;
 
 const Clusterer& getBaseClusterer() const;

 static Vector< std::string > getRegisteredClusterers();
 
 //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 saveClustererSettingsToFile( std::fstream &file ) const;
 
 bool loadClustererSettingsFromFile( std::fstream &file );

 UINT numClusters; 
 UINT predictedClusterLabel; 
 Float maxLikelihood;
 Float bestDistance;
 VectorFloat clusterLikelihoods;
 VectorFloat clusterDistances;
 Vector< UINT > clusterLabels;
 bool converged;
 Vector<MinMax> ranges;
 
 static StringClustererMap *getMap() {
 if( !stringClustererMap ){ stringClustererMap = new StringClustererMap; } 
 return stringClustererMap; 
 }
 
private:
 static StringClustererMap *stringClustererMap;
 static UINT numClustererInstances;
 
};
 
template< typename T > Clusterer* createNewClustererModuleInstance() { return new T; } 

template< typename T >
class RegisterClustererModule : Clusterer { 
public:
 RegisterClustererModule( const std::string &newModuleId ) { 
 getMap()->insert( std::pair< std::string, Clusterer*(*)() >(newModuleId, &createNewClustererModuleInstance< T > ) );
 }
};

GRT_END_NAMESPACE

#endif //GRT_CLUSTERER_HEADER