PLearn 0.1
ToBagSplitter.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ToBagSplitter.h
00004 //
00005 // Copyright (C) 2004 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 /* *******************************************************
00036  * $Id: ToBagSplitter.h 9052 2008-05-23 20:57:32Z tihocan $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef ToBagSplitter_INC
00045 #define ToBagSplitter_INC
00046 
00047 #include "Splitter.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class ToBagSplitter: public Splitter
00053 {
00054 
00055 private:
00056 
00057     typedef Splitter inherited;
00058 
00059 protected:
00060 
00061     // *********************
00062     // * protected options *
00063     // *********************
00064 
00065     // Fields below are not options.
00066 
00069     VMat bags_index;
00070 
00071 public:
00072 
00073     // ************************
00074     // * public build options *
00075     // ************************
00076 
00077     int expected_size_of_bag;
00078     bool provide_target;
00079     bool remove_bag;
00080     PP<Splitter> sub_splitter;
00081 
00082     // ****************
00083     // * Constructors *
00084     // ****************
00085 
00086     // Default constructor, make sure the implementation in the .cc
00087     // initializes all fields to reasonable default values.
00088     ToBagSplitter();
00089 
00090 
00091     // ******************
00092     // * Object methods *
00093     // ******************
00094 
00095 private:
00096 
00098     void build_();
00099 
00100 protected:
00101 
00103     static void declareOptions(OptionList& ol);
00104 
00105 public:
00106 
00107     // simply calls inherited::build() then build_()
00108     virtual void build();
00109 
00111     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00112 
00114     PLEARN_DECLARE_OBJECT(ToBagSplitter);
00115 
00116 
00117     // ********************************
00118     // *        Splitter methods      *
00119     // ********************************
00120 
00122     virtual void setDataSet(VMat the_dataset);
00123 
00125     virtual int nsplits() const;
00126 
00128     virtual int nSetsPerSplit() const;
00129 
00131     virtual TVec<VMat> getSplit(int i=0);
00132 
00133 };
00134 
00135 // Declares a few other classes and functions related to this class
00136 DECLARE_OBJECT_PTR(ToBagSplitter);
00137 
00138 } // end of namespace PLearn
00139 
00140 #endif
00141 
00142 
00143 /*
00144   Local Variables:
00145   mode:c++
00146   c-basic-offset:4
00147   c-file-style:"stroustrup"
00148   c-file-offsets:((innamespace . 0)(inline-open . 0))
00149   indent-tabs-mode:nil
00150   fill-column:79
00151   End:
00152 */
00153 // 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