PLearn 0.1
TrainValidTestSplitter.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // TrainValidTestSplitter.h
00004 //
00005 // Copyright (C) 2004 Olivier Delalleau
00006 //
00007 // Redistribution and use in source and binary forms, with or without
00008 // modification, are permitted provided that the following conditions are met:
00009 //
00010 //  1. Redistributions of source code must retain the above copyright
00011 //     notice, this list of conditions and the following disclaimer.
00012 //
00013 //  2. Redistributions in binary form must reproduce the above copyright
00014 //     notice, this list of conditions and the following disclaimer in the
00015 //     documentation and/or other materials provided with the distribution.
00016 //
00017 //  3. The name of the authors may not be used to endorse or promote
00018 //     products derived from this software without specific prior written
00019 //     permission.
00020 //
00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 //
00032 // This file is part of the PLearn library. For more information on the PLearn
00033 // library, go to the PLearn Web site at www.plearn.org
00034 
00035 /* *******************************************************
00036  * $Id: TrainValidTestSplitter.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef TrainValidTestSplitter_INC
00045 #define TrainValidTestSplitter_INC
00046 
00047 #include "Splitter.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class TrainValidTestSplitter: public Splitter
00053 {
00054     typedef Splitter inherited;
00055 
00056 protected:
00057 
00058     // *********************
00059     // * protected options *
00060     // *********************
00061 
00062     // ### declare protected option fields (such as learnt parameters) here
00063     // ...
00064 
00065     // Fields below are not options.
00066 
00068     VMat train_set;
00069 
00071     TMat<int> valid_indices;
00072 
00074     TMat<int> test_indices;
00075 
00076 public:
00077 
00078     // ************************
00079     // * public build options *
00080     // ************************
00081 
00082     bool append_train;
00083     bool append_valid;
00084     int n_splits;
00085     int n_train;
00086     int n_valid;
00087     bool shuffle_valid_and_test;
00088 
00089     // ****************
00090     // * Constructors *
00091     // ****************
00092 
00093     // Default constructor, make sure the implementation in the .cc
00094     // initializes all fields to reasonable default values.
00095     TrainValidTestSplitter();
00096 
00097 
00098     // ******************
00099     // * Object methods *
00100     // ******************
00101 
00102 private:
00104     void build_();
00105 
00106 protected:
00108     static void declareOptions(OptionList& ol);
00109 
00110 public:
00111     // simply calls inherited::build() then build_()
00112     virtual void build();
00113 
00115     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00116 
00118     PLEARN_DECLARE_OBJECT(TrainValidTestSplitter);
00119 
00120 
00121     // ********************************
00122     // *        Splitter methods      *
00123     // ********************************
00124 
00127     virtual void setDataSet(VMat the_dataset);
00128 
00130     virtual int nsplits() const;
00131 
00133     virtual int nSetsPerSplit() const;
00134 
00136     virtual TVec<VMat> getSplit(int i=0);
00137 
00138 };
00139 
00140 // Declares a few other classes and functions related to this class
00141 DECLARE_OBJECT_PTR(TrainValidTestSplitter);
00142 
00143 } // end of namespace PLearn
00144 
00145 #endif
00146 
00147 
00148 /*
00149   Local Variables:
00150   mode:c++
00151   c-basic-offset:4
00152   c-file-style:"stroustrup"
00153   c-file-offsets:((innamespace . 0)(inline-open . 0))
00154   indent-tabs-mode:nil
00155   fill-column:79
00156   End:
00157 */
00158 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines