TrainValidTestSplitter.h

Go to the documentation of this file.

// -*- C++ -*-

// TrainValidTestSplitter.h
//
// Copyright (C) 2004 Olivier Delalleau 
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org

/* *******************************************************      
   * $Id: TrainValidTestSplitter.h,v 1.4 2004/04/05 23:08:03 morinf Exp $ 
   ******************************************************* */

// Authors: Olivier Delalleau

#ifndef TrainValidTestSplitter_INC
#define TrainValidTestSplitter_INC

#include "Splitter.h"

namespace PLearn {
using namespace std;

class TrainValidTestSplitter: public Splitter
{
  typedef Splitter inherited;

protected:

  // *********************
  // * protected options *
  // *********************

  // ### declare protected option fields (such as learnt parameters) here
  // ...

  // Fields below are not options.

  VMat train_set;

  TMat<int> valid_indices;

  TMat<int> test_indices;
    
public:

  // ************************
  // * public build options *
  // ************************

  bool append_train;
  bool append_valid;
  int n_splits;
  int n_train;
  int n_valid;
  bool shuffle_valid_and_test;

  // ****************
  // * Constructors *
  // ****************

  // Default constructor, make sure the implementation in the .cc
  // initializes all fields to reasonable default values.
  TrainValidTestSplitter();


  // ******************
  // * Object methods *
  // ******************

private: 
  void build_();

protected: 
  static void declareOptions(OptionList& ol);

public:
  // simply calls inherited::build() then build_() 
  virtual void build();

  virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies);

  PLEARN_DECLARE_OBJECT(TrainValidTestSplitter);


  // ********************************
  // *        Splitter methods      *
  // ********************************

  virtual void setDataSet(VMat the_dataset);
  
  virtual int nsplits() const;

  virtual int nSetsPerSplit() const;

  virtual TVec<VMat> getSplit(int i=0);

};

// Declares a few other classes and functions related to this class
DECLARE_OBJECT_PTR(TrainValidTestSplitter);
  
} // end of namespace PLearn

#endif

---