PLearn 0.1
SelectSetsSplitter.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SelectSetsSplitter.h
00004 //
00005 // Copyright (C) 2008 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 // Authors: Olivier Delalleau
00036 
00040 #ifndef SelectSetsSplitter_INC
00041 #define SelectSetsSplitter_INC
00042 
00043 #include <plearn/vmat/Splitter.h>
00044 
00045 namespace PLearn {
00046 
00057 class SelectSetsSplitter : public Splitter
00058 {
00059     typedef Splitter inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063     
00064     TVec<int> indices;
00065     PP<Splitter> splitter;
00066 
00067 
00068 public:
00069     //#####  Public Member Functions  #########################################
00070 
00072     SelectSetsSplitter();
00073 
00074     //#####  Splitter Member Functions  #######################################
00075 
00077     virtual int nsplits() const;
00078 
00080     virtual int nSetsPerSplit() const;
00081 
00083     virtual TVec<VMat> getSplit(int i=0);
00084 
00086     virtual void setDataSet(VMat the_dataset);
00087 
00088     //#####  PLearn::Object Protocol  #########################################
00089 
00090     // Declares other standard object methods.
00091     PLEARN_DECLARE_OBJECT(SelectSetsSplitter);
00092 
00093     // Simply calls inherited::build() then build_()
00094     virtual void build();
00095 
00097     // (PLEASE IMPLEMENT IN .cc)
00098     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00099 
00100 protected:
00101     //#####  Protected Options  ###############################################
00102 
00103     // ### Declare protected option fields (such as learned parameters) here
00104     // ...
00105 
00106 protected:
00107     //#####  Protected Member Functions  ######################################
00108 
00110     // (PLEASE IMPLEMENT IN .cc)
00111     static void declareOptions(OptionList& ol);
00112 
00113 private:
00114     //#####  Private Member Functions  ########################################
00115 
00117     // (PLEASE IMPLEMENT IN .cc)
00118     void build_();
00119 
00120 private:
00121     //#####  Private Data Members  ############################################
00122 
00123     // The rest of the private stuff goes here
00124 };
00125 
00126 // Declares a few other classes and functions related to this class
00127 DECLARE_OBJECT_PTR(SelectSetsSplitter);
00128 
00129 } // end of namespace PLearn
00130 
00131 #endif
00132 
00133 
00134 /*
00135   Local Variables:
00136   mode:c++
00137   c-basic-offset:4
00138   c-file-style:"stroustrup"
00139   c-file-offsets:((innamespace . 0)(inline-open . 0))
00140   indent-tabs-mode:nil
00141   fill-column:79
00142   End:
00143 */
00144 // 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