PLearn 0.1
SourceVMatrixSplitter.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SourceVMatrixSplitter.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: SourceVMatrixSplitter.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef SourceVMatrixSplitter_INC
00045 #define SourceVMatrixSplitter_INC
00046 
00047 #include "SourceVMatrix.h"
00048 #include "Splitter.h"
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00053 class SourceVMatrixSplitter: public Splitter
00054 {
00055 
00056 private:
00057 
00058     typedef Splitter inherited;
00059 
00060 protected:
00061     // *********************
00062     // * protected options *
00063     // *********************
00064 
00065     // ### declare protected option fields (such as learnt parameters) here
00066     // ...
00067 
00068 public:
00069 
00070     // ************************
00071     // * public build options *
00072     // ************************
00073 
00074     PP<SourceVMatrix> source_vm;
00075     PP<Splitter> source_splitter;
00076     int to_apply;
00077     TVec<int> sets_to_modify;
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     SourceVMatrixSplitter();
00086 
00087 
00088     // ******************
00089     // * Object methods *
00090     // ******************
00091 
00092 private:
00094     // (Please implement in .cc)
00095     void build_();
00096 
00097 protected:
00099     // (Please implement in .cc)
00100     static void declareOptions(OptionList& ol);
00101 
00102 public:
00103     // simply calls inherited::build() then build_()
00104     virtual void build();
00105 
00107     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00108 
00110     PLEARN_DECLARE_OBJECT(SourceVMatrixSplitter);
00111 
00112 
00113     // ********************************
00114     // *        Splitter methods      *
00115     // ********************************
00116 
00118     virtual void setDataSet(VMat the_dataset);
00119 
00121     virtual int nsplits() const;
00122 
00124     virtual int nSetsPerSplit() const;
00125 
00127     virtual TVec<VMat> getSplit(int i=0);
00128 
00129 };
00130 
00131 // Declares a few other classes and functions related to this class
00132 DECLARE_OBJECT_PTR(SourceVMatrixSplitter);
00133 
00134 } // end of namespace PLearn
00135 
00136 #endif
00137 
00138 
00139 /*
00140   Local Variables:
00141   mode:c++
00142   c-basic-offset:4
00143   c-file-style:"stroustrup"
00144   c-file-offsets:((innamespace . 0)(inline-open . 0))
00145   indent-tabs-mode:nil
00146   fill-column:79
00147   End:
00148 */
00149 // 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