source: branches/0.4-stable/yat/classifier/FeatureSelector.h @ 1392

#ifndef _theplu_yat_classifier_featureselector_
#define _theplu_yat_classifier_featureselector_

// $Id$

/*
  Copyright (C) 2006, 2007 Jari Häkkinen, Peter Johansson
  Copyright (C) 2008 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include "yat/utility/Index.h"

#include <list>

namespace theplu {
namespace yat {
namespace classifier {
  class MatrixLookup;
  class MatrixLookupWeighted;
  class Target;

  ///
  /// @brief Interface class for FeatureSelection
  ///
  class FeatureSelector
  {
  public:
    /// 
    /// @brief Default Constructor 
    /// 
    FeatureSelector(size_t N, size_t skip=0);

    /// 
    /// Cleaning upp all objects that have beed returned from FeatureSelector.
    ///
    /// @brief Destructor
    /// 
    virtual ~FeatureSelector(void);

    ///
    /// @return MatrixLookup containing only selected features. 
    ///
    const MatrixLookup get(const MatrixLookup& data);

    ///
    /// @return MatrixLookupWeighted containing only selected features. 
    ///
    const MatrixLookupWeighted get(const MatrixLookupWeighted& data);

    ///
    /// @return indices corresponding to selected features.
    ///
    const utility::Index features(void) const;

    ///
    /// Uses @a matrix to select features.
    ///
    virtual void update(const MatrixLookup& matrix, const Target& target)=0;

    ///
    /// Uses @a matrix to select features.
    ///
    virtual void update(const MatrixLookupWeighted& matrix, 
                        const Target& target)=0;

  protected:
    ///
    /// @brief features
    ///
    utility::Index features_;

    ///
    /// number of features to skip in list
    ///
    size_t first_;

    ///
    /// number of features selected and returned
    ///
    size_t N_;

  private:

  };

}}} // of namespace classifier, yat, and theplu

#endif