PLearn 0.1
KFoldSplitter.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // KFoldSplitter.h
00004 //
00005 // Copyright (C) 1998 Pascal Vincent
00006 // Copyright (C) 1999,2000 Pascal Vincent, Yoshua Bengio and University of Montreal
00007 // Copyright (C) 2002 Frederic Morin
00008 //
00009 // Redistribution and use in source and binary forms, with or without
00010 // modification, are permitted provided that the following conditions are met:
00011 //
00012 //  1. Redistributions of source code must retain the above copyright
00013 //     notice, this list of conditions and the following disclaimer.
00014 //
00015 //  2. Redistributions in binary form must reproduce the above copyright
00016 //     notice, this list of conditions and the following disclaimer in the
00017 //     documentation and/or other materials provided with the distribution.
00018 //
00019 //  3. The name of the authors may not be used to endorse or promote
00020 //     products derived from this software without specific prior written
00021 //     permission.
00022 //
00023 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00024 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00025 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00026 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00027 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00028 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 //
00034 // This file is part of the PLearn library. For more information on the PLearn
00035 // library, go to the PLearn Web site at www.plearn.org
00036 
00037 /* *******************************************************
00038  * $Id: KFoldSplitter.h 9061 2008-05-26 18:37:46Z louradou $
00039  ******************************************************* */
00040 
00042 #ifndef KFoldSplitter_INC
00043 #define KFoldSplitter_INC
00044 
00045 #include "Splitter.h"
00046 
00047 namespace PLearn {
00048 using namespace std;
00049 
00050 class KFoldSplitter: public Splitter
00051 {
00052     typedef Splitter inherited;
00053 
00054 protected:
00055 
00056     // *********************
00057     // * protected options *
00058     // *********************
00059 
00060 
00061 public:
00062 
00063     // ************************
00064     // * public build options *
00065     // ************************
00066 
00067     bool append_non_constant_test;
00068     bool append_train;
00069     pair<real, real> cross_range;
00070     bool include_test_in_train;
00071     bool balance_classes;
00072     int K;
00073 
00074     // ****************
00075     // * Constructors *
00076     // ****************
00077 
00079     KFoldSplitter(int k = 5);
00080 
00081     // ******************
00082     // * Object methods *
00083     // ******************
00084 
00085 private:
00087     void build_();
00088 
00089 protected:
00091     static void declareOptions(OptionList& ol);
00092 
00093 public:
00094     // simply calls inherited::build() then build_()
00095     virtual void build();
00096 
00098     PLEARN_DECLARE_OBJECT(KFoldSplitter);
00099 
00100 
00101     // ********************************
00102     // *        Splitter methods      *
00103     // ********************************
00104 
00106     virtual int nsplits() const;
00107 
00109     virtual int nSetsPerSplit() const;
00110 
00112     virtual TVec<VMat> getSplit(int i=0);
00113 
00114 };
00115 
00116 // Declares a few other classes and functions related to this class
00117 DECLARE_OBJECT_PTR(KFoldSplitter);
00118 
00119 } // end of namespace PLearn
00120 
00121 #endif // KFoldSplitter_INC
00122 
00123 
00124 /*
00125   Local Variables:
00126   mode:c++
00127   c-basic-offset:4
00128   c-file-style:"stroustrup"
00129   c-file-offsets:((innamespace . 0)(inline-open . 0))
00130   indent-tabs-mode:nil
00131   fill-column:79
00132   End:
00133 */
00134 // 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