source: trunk/lib/classifier/DataLookup2D.h @ 482

// $Id$

#ifndef _theplu_classifier_DataLookup2D_ 
#define _theplu_classifier_DataLookup2D_ 

#include <vector>
#include <iostream>

namespace theplu {
namespace classifier {  

  ///
  /// Interface class for classifier data
  ///

  class DataLookup2D
  {
  
  public:

    ///
    /// Constructor taking the row index vector and column index vector 
    /// as input. 
    ///
    DataLookup2D(const std::vector<size_t>&, const std::vector<size_t>&);

    ///
    /// Constructor taking the row index vector or 
    /// column index vector (default) 
    ///
    DataLookup2D(const std::vector<size_t>&, bool row=false);


    ///
    /// Copy constructor.
    ///
    DataLookup2D(const DataLookup2D&);

    ///
    ///
    ///
    DataLookup2D(const DataLookup2D&, const std::vector<size_t>& row, 
               const std::vector<size_t>& col);

    ///
    ///
    ///
    DataLookup2D(const DataLookup2D&, const std::vector<size_t>& index, 
               const bool row);


    ///
    /// Destructor
    ///
    virtual ~DataLookup2D() {};

    ///
    /// @return number of columns
    ///
    inline size_t columns(void) const { return column_index_.size(); } 

    ///
    /// @return sub-Lookup of the DataLookup2D
    ///
    /// @Note Returns a dynamically allocated DataLookup2D, which has
    /// to be deleted by the caller to avoid memory leaks.
    ///
    virtual const DataLookup2D* 
    training_data(const std::vector<size_t>&) const=0; 

    ///
    /// @return number of rows
    ///
    inline size_t rows(void) const { return row_index_.size(); } 

    ///
    /// @return sub-Lookup of the DataLookup2D
    ///
    /// @Note Returns a dynamically allocated DataLookup2D, which has
    /// to be deleted by the caller to avoid memory leaks.
    ///
    virtual const DataLookup2D* 
    validation_data(const std::vector<size_t>& train,
                    const std::vector<size_t>& val) const=0; 

    ///
    /// @return 
    ///
    virtual double operator()(const size_t row, const size_t column) const=0;

  protected:
    std::vector<size_t> row_index_;
    std::vector<size_t> column_index_;
    
    ///
    /// Default constructor.
    ///
    DataLookup2D() {};

  };  
  
}} // of namespace classifier and namespace theplu

#endif