Splitter.h

Go to the documentation of this file.

// -*- C++ -*-

// Splitter.h
// 
// Copyright (C) 2002 Pascal Vincent, Frederic Morin
// 
// 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: Splitter.h,v 1.10 2004/07/21 16:30:55 chrish42 Exp $ 
   ******************************************************* */

#ifndef Splitter_INC
#define Splitter_INC

#include <plearn/base/Object.h>
#include <plearn/base/Array.h>
#include "VMat.h"

namespace PLearn {
using namespace std;

class Splitter: public Object
{
  typedef Object inherited;

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

    VMat dataset;
    
public:
  // ****************
  // * Constructors *
  // ****************

  PLEARN_DECLARE_ABSTRACT_OBJECT(Splitter);

  Splitter() {};

  virtual void setDataSet(VMat the_dataset);

  VMat getDataSet()
  { return dataset; }

  virtual int nsplits() const = 0;

  virtual int nSetsPerSplit() const = 0;

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

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

};

// Declares a few other classes and functions related to this class
DECLARE_OBJECT_PTR(Splitter);


// A few useful function for splitting the datasets... (can be called in Splitter subclasses

void split(VMat d, real test_fraction, VMat& train, VMat& test, int i = 0, bool use_all = false);

void split(VMat d, real validation_fraction, real test_fraction, VMat& train, VMat& valid, VMat& test,bool do_shuffle=false);
                                    
Vec randomSplit(VMat d, real test_fraction, VMat& train, VMat& test);

void randomSplit(VMat d, real validation_fraction, real test_fraction, VMat& train, VMat& valid, VMat& test);

  
} // end of namespace PLearn

#endif

---