source: trunk/yat/classifier/InputRanker.h @ 2986

#ifndef _theplu_yat_classifier_inputranker_ 
#define _theplu_yat_classifier_inputranker_ 

// $Id$

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

  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 3 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 yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include <cstddef>
#include <vector>

namespace theplu {
namespace yat {
namespace statistics {
  class Score;
}
namespace classifier {  

  class MatrixLookup;
  class MatrixLookupWeighted;
  class Target;

  ///
  /// @brief Class for ranking rows in a matrix, using a Score and a
  /// target vector.
  ///   
  class InputRanker
  {

  public:
    ///
    /// Constructor taking data, target, a Score
    /// object and vector defining what samples to use (default is to
    /// use all samples)
    ///
    InputRanker(const MatrixLookup&, const Target&, const statistics::Score&); 

    ///
    /// Constructor taking data, target, a Score
    /// object and vector defining what samples to use (default is to
    /// use all samples)
    ///
    InputRanker(const MatrixLookupWeighted&, const Target&, 
                const statistics::Score&); 

    ///
    /// highest ranked gene is ranked as number zero @return id
    /// (index) of input ranked as number \a i
    ///
    const std::vector<size_t>& id(void) const;

    ///
    /// highest ranked gene is ranked as number zero @return rank for
    /// id (row) \a i
    ///
    const std::vector<size_t>& rank(void) const;

    ///
    /// @param rank should be a number in range [0,N-1] where N is number
    /// of inputs in data matrix. "score(0)" will gives the score of
    /// the feature that had the highest score. 
    ///
    /// @return score of the input that has been been ranked as
    /// number @a rank.
    ///
    double score(size_t rank) const;

  private:
    std::vector<size_t> id_;
    std::vector<size_t> rank_;
    std::vector<double> score_;
  };


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

#endif