Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

SequentialSplitter.h

Go to the documentation of this file.
00001 // -*- C++ -*- 00002 00003 // SequentialSplitter.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 // Copyright (C) 2004 Rejean Ducharme 00009 // 00010 // Redistribution and use in source and binary forms, with or without 00011 // modification, are permitted provided that the following conditions are met: 00012 // 00013 // 1. Redistributions of source code must retain the above copyright 00014 // notice, this list of conditions and the following disclaimer. 00015 // 00016 // 2. Redistributions in binary form must reproduce the above copyright 00017 // notice, this list of conditions and the following disclaimer in the 00018 // documentation and/or other materials provided with the distribution. 00019 // 00020 // 3. The name of the authors may not be used to endorse or promote 00021 // products derived from this software without specific prior written 00022 // permission. 00023 // 00024 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 00025 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00026 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 00027 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00028 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 00029 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00030 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00031 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00032 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00033 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00034 // 00035 // This file is part of the PLearn library. For more information on the PLearn 00036 // library, go to the PLearn Web site at www.plearn.org 00037 00038 /* ******************************************************* 00039 * $Id: SequentialSplitter.h,v 1.8 2004/05/06 21:22:12 ducharme Exp $ 00040 ******************************************************* */ 00041 00043 #ifndef SequentialSplitter_INC 00044 #define SequentialSplitter_INC 00045 00046 #include "Splitter.h" 00047 00048 namespace PLearn { 00049 using namespace std; 00050 00051 class SequentialSplitter: public Splitter 00052 { 00053 typedef Splitter inherited; 00054 00055 public: 00056 // ************************ 00057 // * public build options * 00058 // ************************ 00059 00060 int horizon; 00061 int init_train_size; 00062 bool return_entire_vmat; 00063 00064 // **************** 00065 // * Constructors * 00066 // **************** 00067 00068 // Default constructor, make sure the implementation in the .cc 00069 // initializes all fields to reasonable default values. 00070 SequentialSplitter(int horizon_=1, int init_train_size_=1, bool return_entire_vmat_=true); 00071 00072 // ****************** 00073 // * Object methods * 00074 // ****************** 00075 00076 private: 00078 // (Please implement in .cc) 00079 void build_(); 00080 00081 protected: 00083 // (Please implement in .cc) 00084 static void declareOptions(OptionList& ol); 00085 00086 public: 00087 // simply calls inherited::build() then build_() 00088 virtual void build(); 00089 00091 PLEARN_DECLARE_OBJECT(SequentialSplitter); 00092 00093 00094 // ******************************** 00095 // * Splitter methods * 00096 // * (must be implemented in .cc) * 00097 // ******************************** 00098 00100 virtual int nsplits() const; 00101 00103 virtual int nSetsPerSplit() const; 00104 00106 virtual TVec<VMat> getSplit(int i=0); 00107 00108 }; 00109 00110 // Declares a few other classes and functions related to this class 00111 DECLARE_OBJECT_PTR(SequentialSplitter); 00112 00113 } // end of namespace PLearn 00114 00115 #endif // SequentialSplitter_INC

Generated on Tue Aug 17 16:05:26 2004 for PLearn by doxygen 1.3.7