00001 // -*- C++ -*- 00002 00003 // TrainTestBagsSplitter.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: TrainTestBagsSplitter.h,v 1.2 2004/03/23 23:08:09 morinf Exp $ 00039 ******************************************************* */ 00040 00042 #ifndef TrainTestBagsSplitter_INC 00043 #define TrainTestBagsSplitter_INC 00044 00045 #include "Splitter.h" 00046 00047 namespace PLearn { 00048 using namespace std; 00049 00050 class TrainTestBagsSplitter: public Splitter 00051 { 00052 typedef Splitter inherited; 00053 00054 protected: 00055 // ********************* 00056 // * protected options * 00057 // ********************* 00058 00059 // ### declare protected option fields (such as learnt parameters) here 00060 // ... 00061 00062 public: 00063 // ************************ 00064 // * public build options * 00065 // ************************ 00066 00067 int append_train; 00068 real test_fraction; // the fraction of the dataset to be used as test (these will be the last few samples of the dataset) 00069 00070 // **************** 00071 // * Constructors * 00072 // **************** 00073 00074 // Default constructor, make sure the implementation in the .cc 00075 // initializes all fields to reasonable default values. 00076 TrainTestBagsSplitter(real the_test_fraction = 0.0); 00077 00078 // ****************** 00079 // * Object methods * 00080 // ****************** 00081 00082 private: 00084 // (Please implement in .cc) 00085 void build_(); 00086 00087 protected: 00089 // (Please implement in .cc) 00090 static void declareOptions(OptionList& ol); 00091 00092 public: 00093 // simply calls inherited::build() then build_() 00094 virtual void build(); 00095 00097 PLEARN_DECLARE_OBJECT(TrainTestBagsSplitter); 00098 00099 00100 // ******************************** 00101 // * Splitter methods * 00102 // * (must be implemented in .cc) * 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(TrainTestBagsSplitter); 00118 00119 } // end of namespace PLearn 00120 00121 #endif