source: trunk/yat/classifier/Sampler.h @ 680

#ifndef _theplu_yat_classifier_sampler_ 
#define _theplu_yat_classifier_sampler_ 

// $Id: Sampler.h 680 2006-10-11 17:49:03Z jari $

/*
  Copyright (C) 2006 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 "Target.h"

#include <vector>

namespace theplu {
namespace yat {
namespace classifier {  

  ///
  /// Interface for dividing samples into training and validation.
  ///   

  class Sampler
  {
  
  public:
    ///
    /// @brief Constructor 
    ///  
    /// @param target used to balance partitions
    ///
    Sampler(const Target& target);

    ///
    /// Destructor (pure virtual destructor)
    ///
    virtual ~Sampler() =0;

    ///
    /// @return number of partitions
    ///
    inline u_long size(void) const { return training_index_.size(); }

    ///
    /// @return the targets for the total set
    ///
    inline const Target& target(void) const { return target_; }

    ///
    /// @return training indices
    ///
    inline const std::vector<size_t>& 
    training_index(std::vector<size_t>::size_type i) const
    { return training_index_[i]; }

    ///
    /// @return training target
    ///
    /// @note if state is invalid the result is undefined
    ///
    inline const Target& 
    training_target(std::vector<Target>::size_type i) const 
    { return training_target_[i]; }

    ///
    /// @return validation index
    ///
    /// @note if state is invalid the result is undefined
    ///
    inline const std::vector<size_t>& 
    validation_index(std::vector<size_t>::size_type i) const
    { return validation_index_[i]; }

    ///
    /// @return validation target
    ///
    /// @note if state is invalid the result is undefined
    ///
    inline const Target& 
    validation_target(std::vector<Target>::size_type i) const 
    { return validation_target_[i]; }


  protected:
    /// Target used to balance partitions
    Target target_;
    /// index of training sets for the partitions
    std::vector<std::vector<size_t> > training_index_;
    /// Targets for training sets for the partitions
    std::vector<Target> training_target_;
    /// index of validation sets for the partitions
    std::vector<std::vector<size_t> > validation_index_;
    /// Targets for validation sets for the partitions
    std::vector<Target> validation_target_;

  };

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

#endif