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