source: trunk/lib/classifier/SupervisedClassifier.h @ 523

// $Id: SupervisedClassifier.h 523 2006-02-23 08:52:04Z peter $

#ifndef _theplu_classifier_supervisedclassifier_ 
#define _theplu_classifier_supervisedclassifier_ 


namespace theplu {

  namespace gslapi {
    class vector;
    class matrix;
  }

namespace classifier {  

  class DataLookup2D;
  class Target;


  ///
  /// Interface class for supervised classifiers
  ///

  class SupervisedClassifier
  {
   
  public:
    ///
    /// Constructor. Taking a vector of target values.
    ///
    SupervisedClassifier(const Target&);
    
    ///
    /// Destructor
    ///
    virtual ~SupervisedClassifier() {};

    ///
    /// An interface for making new classifier objects. This function
    /// allows for specification at run-time of which classifier to
    /// instatiate (see 'Prototype' in Design Patterns).
    ///
    /// @Note Returns a dynamically allocated SupervisedClassifier, which has
    /// to be deleted by the caller to avoid memory leaks.
    ///
    virtual SupervisedClassifier* 
    make_classifier(const DataLookup2D&, const Target&) const =0;
    

    //
    // Train the classifier.
    //
    virtual bool train()=0;

    ///
    /// Generate output values for a data set
    ///
    virtual void predict(const DataLookup2D&, gslapi::matrix&) const =0;    

    
  protected:
    
    const Target& target_;
    bool trained_;
    
    
  };  
  
}} // of namespace classifier and namespace theplu

#endif