source: trunk/yat/classifier/Target.h @ 831

#ifndef _theplu_yat_classifier_target_ 
#define _theplu_yat_classifier_target_ 

// $Id$

/*
  Copyright (C) 2005 Peter Johansson
  Copyright (C) 2006 Jari Häkkinen, Markus Ringnér, Peter Johansson
  Copyright (C) 2007 Jari Häkkinen, Peter Johansson

  This file is part of the yat library, http://lev.thep.lu.se/trac/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/Exception.h"

#include <iosfwd>
#include <map>
#include <stdexcept>
#include <string>
#include <vector>

namespace theplu {
namespace yat {
namespace classifier {  

  ///
  /// @brief Class for containing sample labels.
  ///

  class Target
  {
  
  public:
    ///
    /// @brief Constructor creating target with @a labels
    ///
    explicit Target(const std::vector<std::string>& labels);

    ///
    /// @brief istream constructor.
    ///
    Target(std::istream&, char sep='\0') 
      throw (utility::IO_error,std::exception);

    ///
    /// @brief Copy Constructor 
    ///
    //Target(const Target& other) 
    //  : classes_(other.classes_), class_map_(other.class_map_), 
    //    labels_(other.labels_) {}

    ///
    /// Constructor creating a sub-Target from Target @a org. @a vec
    /// defines which indices to use.
    ///
    /// @note class is preserved, i.e., operator() returns the same
    /// for the Target as the original Target.
    ///
    Target(const Target& org, const std::vector<size_t>& vec);

    ///
    /// @brief Destructor
    ///
    ~Target();

    ///
    /// @return a map with label as key and class as value.
    ///
    const std::map<std::string,size_t>& classes(void) const;
    
    ///
    /// This function is equivalent to Target::classes().size()
    ///
    /// @return number of classes
    ///
    const size_t nof_classes(void) const;

    ///
    /// @brief Default binary is set to false for all classes except
    /// class 0.
    ///
    /// @return binary target for sample @a i
    ///
    /// @see set_binary
    ///
    bool binary(size_t i) const;
    
    ///
    /// The size of returned vector is equal to number of classes. To
    /// get label label of sample i you need to call
    /// target.labels()[target(i)]
    ///
    /// @return vector of labels for classes
    ///
    const std::vector<std::string>& labels(void);

    ///
    /// Binary target for each sample with class @a i is set to @a
    /// b. Default is binary set to false for each class except class
    /// 0 which is set to true.
    ///
    void set_binary(size_t i, bool b);

    ///
    /// @brief randomize labels
    ///
    /// Randomizes classes. Number of samples with a specific label is
    /// not modified, neither mapping from label to class.
    ///
    void random_shuffle(void);

    ///
    /// @return number of samples
    ///
    size_t size(void) const;

    ///
    /// @return number of samples with label @a label
    ///
    const size_t size(const std::string& label) const;

    ///
    /// @return number of samples with class @a cl
    ///
    const size_t size(size_t cl) const;


    ///
    /// @return the class of @a sample
    ///
    size_t operator()(size_t sample) const;
    
    ///
    /// @return the class of @a sample
    ///
    size_t operator[](size_t sample) const;

    ///
    /// @brief assignment operator
    ///
    const Target& operator=(const Target&);

  private:
    // binary target for class i
    std::vector<char> binary_; // avoid using vector<bool>
    std::vector<size_t> classes_; // class of sample i
    // map between class label and class index (inverse of labels_)
    std::map<std::string,size_t> class_map_;  
    std::vector<std::string> labels_; // label of class i
    
    void init(const std::vector<std::string>&);

  };  
  
  ///
  /// The output operator for the Target class.
  ///
  std::ostream& operator<<(std::ostream&, const Target& );

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

#endif