PLearn 0.1
TestInTrainSplitter.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // TestInTrainSplitter.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: TestInTrainSplitter.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef TestInTrainSplitter_INC
00045 #define TestInTrainSplitter_INC
00046 
00047 #include "Splitter.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class TestInTrainSplitter: public Splitter
00053 {
00054 
00055 private:
00056 
00057     typedef Splitter inherited;
00058 
00059 protected:
00060     // *********************
00061     // * protected options *
00062     // *********************
00063 
00064     // ### declare protected option fields (such as learnt parameters) here
00065     // ...
00066 
00067     // Fields below are not options.
00068 
00072     mutable TVec<VMat> first_source_split;
00073 
00076     mutable int n_left;
00077 
00079     mutable int n_splits_per_source_split;
00080 
00083     mutable int n_train, n_test;
00084 
00086     mutable int n_to_add;
00087 
00088 public:
00089 
00090     // ************************
00091     // * public build options *
00092     // ************************
00093 
00094     real percentage_added;
00095     PP<Splitter> source_splitter;
00096 
00097     // ****************
00098     // * Constructors *
00099     // ****************
00100 
00101     // Default constructor, make sure the implementation in the .cc
00102     // initializes all fields to reasonable default values.
00103     TestInTrainSplitter();
00104 
00105 
00106     // ******************
00107     // * Object methods *
00108     // ******************
00109 
00110 private:
00112     // (Please implement in .cc)
00113     void build_();
00114 
00115 protected:
00117     // (Please implement in .cc)
00118     static void declareOptions(OptionList& ol);
00119 
00120 public:
00121     // simply calls inherited::build() then build_()
00122     virtual void build();
00123 
00125     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00126 
00128     PLEARN_DECLARE_OBJECT(TestInTrainSplitter);
00129 
00130 
00131     // ********************************
00132     // *        Splitter methods      *
00133     // ********************************
00134 
00136     virtual void setDataSet(VMat the_dataset);
00137 
00139     virtual int nsplits() const;
00140 
00142     virtual int nSetsPerSplit() const;
00143 
00145     virtual void getFirstSplit() const;
00146 
00148     virtual TVec<VMat> getSplit(int i=0);
00149 
00150 };
00151 
00152 // Declares a few other classes and functions related to this class
00153 DECLARE_OBJECT_PTR(TestInTrainSplitter);
00154 
00155 } // end of namespace PLearn
00156 
00157 #endif
00158 
00159 
00160 /*
00161   Local Variables:
00162   mode:c++
00163   c-basic-offset:4
00164   c-file-style:"stroustrup"
00165   c-file-offsets:((innamespace . 0)(inline-open . 0))
00166   indent-tabs-mode:nil
00167   fill-column:79
00168   End:
00169 */
00170 // 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