PLearn 0.1
RandomSamplesFromVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RandomSamplesFromVMatrix.h
00004 //
00005 // Copyright (C) 2006 Hugo Larochelle
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: Hugo Larochelle
00036 
00040 #ifndef RandomSamplesFromVMatrix_INC
00041 #define RandomSamplesFromVMatrix_INC
00042 
00043 #include <plearn/vmat/RowBufferedVMatrix.h>
00044 #include <plearn/math/PRandom.h>
00045 #include <plearn/vmat/VMat.h>
00046 
00047 namespace PLearn {
00048 
00055 class RandomSamplesFromVMatrix : public RowBufferedVMatrix
00056 {
00057     typedef RowBufferedVMatrix inherited;
00058 
00059 public:
00060     //#####  Public Build Options  ############################################
00061 
00063     VMat source;
00065     real flength;
00067     int32_t seed;
00068 
00069 public:
00070     //#####  Public Member Functions  #########################################
00071 
00073     // ### Make sure the implementation in the .cc
00074     // ### initializes all fields to reasonable default values.
00075     RandomSamplesFromVMatrix();
00076 
00077     //#####  PLearn::Object Protocol  #########################################
00078 
00079     // Declares other standard object methods.
00080     // ### If your class is not instantiatable (it has pure virtual methods)
00081     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00082     PLEARN_DECLARE_OBJECT(RandomSamplesFromVMatrix);
00083 
00084     // Simply calls inherited::build() then build_()
00085     virtual void build();
00086 
00088     // (PLEASE IMPLEMENT IN .cc)
00089     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00090 
00093     virtual PP<Dictionary> getDictionary(int col) const;
00094 
00096     virtual void getValues(int row, int col, Vec& values) const;
00097 
00099     virtual void getValues(const Vec& input, int col, Vec& values) const;
00100 
00101 
00102 protected:
00103     //#####  Protected Options  ###############################################
00104 
00106     PP<PRandom> rgen;
00107 
00108 protected:
00109     //#####  Protected Member Functions  ######################################
00110 
00112     // (PLEASE IMPLEMENT IN .cc)
00113     static void declareOptions(OptionList& ol);
00114 
00117     // (PLEASE IMPLEMENT IN .cc)
00118     virtual void getNewRow(int i, const Vec& v) const;
00119 
00120 private:
00121     //#####  Private Member Functions  ########################################
00122 
00124     // (PLEASE IMPLEMENT IN .cc)
00125     void build_();
00126 
00127 private:
00128     //#####  Private Data Members  ############################################
00129 
00130     // The rest of the private stuff goes here
00131 };
00132 
00133 // Declares a few other classes and functions related to this class
00134 DECLARE_OBJECT_PTR(RandomSamplesFromVMatrix);
00135 
00136 } // end of namespace PLearn
00137 
00138 #endif
00139 
00140 
00141 /*
00142   Local Variables:
00143   mode:c++
00144   c-basic-offset:4
00145   c-file-style:"stroustrup"
00146   c-file-offsets:((innamespace . 0)(inline-open . 0))
00147   indent-tabs-mode:nil
00148   fill-column:79
00149   End:
00150 */
00151 // 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