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

#ifndef _theplu_yat_classifier_sampler_ 
#define _theplu_yat_classifier_sampler_ 

// $Id: Sampler.h 865 2007-09-10 19:41:04Z peter $

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

  This file is part of the yat library, http://trac.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 {  

  ///
  /// @brief Interface class for dividing samples into training and
  /// validation.
  ///   

  class Sampler
  {

  public:
    ///
    /// @brief Constructor 
    ///
    /// @param target used to balance partitions
    /// @param Number of partitions
    ///
    Sampler(const Target& target, size_t N);

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

    ///
    /// @return number of partitions
    ///
    u_long size(void) const;

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

    ///
    /// @return training indices
    ///
    const std::vector<size_t>&
    training_index(std::vector<size_t>::size_type i) const;

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

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

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

  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