PLearn 0.1
MultiSampleVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // MultiSampleVariable.h
00004 //
00005 // Copyright (C) 2007 Simon Lemieux, 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 // Authors: Simon Lemieux, Pascal Vincent
00036 
00040 #ifndef MultiSampleVariable_INC
00041 #define MultiSampleVariable_INC
00042 
00043 #include <plearn/var/UnaryVariable.h>
00044 #include <plearn/math/PRandom.h>
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00058 class MultiSampleVariable : public UnaryVariable
00059 {
00060     typedef UnaryVariable inherited;
00061 
00062 public:
00063     //#####  Public Build Options  ############################################
00064 
00067     int groupsize;
00068 
00069     PP<PRandom> random_gen;
00070 
00071 public:
00072     //#####  Public Member Functions  #########################################
00073 
00075     MultiSampleVariable():
00076          groupsize(-1)
00077     {}
00078 
00079 
00080     // ### If your class has parameters, you probably want a constructor that
00081     // ### initializes them
00082     MultiSampleVariable(Variable* input, int groupsize);
00083 
00084     // Your other public member functions go here
00085 
00086     //#####  PLearn::Variable methods #########################################
00087     // (PLEASE IMPLEMENT IN .cc)
00088     virtual void recomputeSize(int& l, int& w) const;
00089     virtual void fprop();
00090     virtual void bprop();
00091 
00092     // ### These ones are not always implemented
00093     // virtual void bbprop();
00094     // virtual void symbolicBprop();
00095     // virtual void rfprop();
00096 
00097     //#####  PLearn::Object Protocol  #########################################
00098 
00099     // Declares other standard object methods.
00100     // ### If your class is not instantiatable (it has pure virtual methods)
00101     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00102     PLEARN_DECLARE_OBJECT(MultiSampleVariable);
00103 
00104     // Simply calls inherited::build() then build_()
00105     virtual void build();
00106 
00108     // (PLEASE IMPLEMENT IN .cc)
00109     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00110 
00111 protected:
00112     //#####  Protected Options  ###############################################
00113 
00114     // ### Declare protected option fields (such as learned parameters) here
00115     // ...
00116 
00117 protected:
00118     //#####  Protected Member Functions  ######################################
00119 
00121     // (PLEASE IMPLEMENT IN .cc)
00122     static void declareOptions(OptionList& ol);
00123 
00124 private:
00125     //#####  Private Member Functions  ########################################
00126 
00128     // (PLEASE IMPLEMENT IN .cc)
00129     void build_();
00130 
00131     //somes utils    
00132     void sample_range(Vec &x, Vec &y, int start, int length);
00133     
00134 
00135 private:
00136     //#####  Private Data Members  ############################################
00137 
00138     // The rest of the private stuff goes here
00139 };
00140 
00141 // Declares a few other classes and functions related to this class
00142 DECLARE_OBJECT_PTR(MultiSampleVariable);
00143 
00144 // ### Put here a convenient method for building your variable.
00145 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo
00146 // ### and bar_type bar, you could write:
00147 // inline Var MultiSample(Var v, TVec<int> groupsizes, char computation_type)
00148 // { return new MultiSampleVariable(v, groupsizes, computation_type); }
00149 
00150 } // end of namespace PLearn
00151 
00152 #endif
00153 
00154 
00155 /*
00156   Local Variables:
00157   mode:c++
00158   c-basic-offset:4
00159   c-file-style:"stroustrup"
00160   c-file-offsets:((innamespace . 0)(inline-open . 0))
00161   indent-tabs-mode:nil
00162   fill-column:79
00163   End:
00164 */
00165 // 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