PLearn 0.1
ExplicitSplitter.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ExplicitSplitter.h
00004 //
00005 // Copyright (C) 2002 Pascal Vincent
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: ExplicitSplitter.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00040 #ifndef ExplicitSplitter_INC
00041 #define ExplicitSplitter_INC
00042 
00043 #include "Splitter.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 class ExplicitSplitter: public Splitter
00049 {
00050     typedef Splitter inherited;
00051 
00052 protected:
00053     // *********************
00054     // * protected options *
00055     // *********************
00056 
00057 public:
00058     // ************************
00059     // * public build options *
00060     // ************************
00061 
00063     TMat <VMat> splitsets;
00064 
00065     // ****************
00066     // * Constructors *
00067     // ****************
00068 
00069     ExplicitSplitter();
00070 
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     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00092 
00094     PLEARN_DECLARE_OBJECT(ExplicitSplitter);
00095 
00096 
00097     // ********************************
00098     // *        Splitter methods      *
00099     // * (must be implemented in .cc) *
00100     // ********************************
00101 
00103     virtual int nsplits() const;
00104 
00106     virtual int nSetsPerSplit() const;
00107 
00109     virtual TVec<VMat> getSplit(int i=0);
00110 
00111 };
00112 
00113 // Declares a few other classes and functions related to this class
00114 DECLARE_OBJECT_PTR(ExplicitSplitter);
00115 
00116 } // end of namespace PLearn
00117 
00118 #endif
00119 
00120 
00121 /*
00122   Local Variables:
00123   mode:c++
00124   c-basic-offset:4
00125   c-file-style:"stroustrup"
00126   c-file-offsets:((innamespace . 0)(inline-open . 0))
00127   indent-tabs-mode:nil
00128   fill-column:79
00129   End:
00130 */
00131 // 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