PLearn 0.1
VMatrixFromDistribution.h
Go to the documentation of this file.
00001 
00002 // -*- C++ -*-
00003 
00004 // VMatrixFromDistribution.h
00005 //
00006 // Copyright (C) 2003  Pascal Vincent
00007 //
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 //
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 //
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 //
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 //
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 //
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 /* *******************************************************
00037  * $Id: VMatrixFromDistribution.h 7733 2007-07-10 01:19:04Z lamblin $
00038  ******************************************************* */
00039 
00041 #ifndef VMatrixFromDistribution_INC
00042 #define VMatrixFromDistribution_INC
00043 
00044 #include "VMatrix.h"
00045 #include <plearn_learners/distributions/PDistribution.h>
00046 
00047 namespace PLearn {
00048 using namespace std;
00049 
00050 class VMatrixFromDistribution: public VMatrix
00051 {
00052 
00053 private:
00054 
00055     typedef VMatrix inherited;
00056 
00057 protected:
00058 
00060     Mat data;
00061 
00062 public:
00063 
00064     // ************************
00065     // * public build options *
00066     // ************************
00067 
00068     PP<PDistribution> distr; // the distribution
00069     string mode; // one of "sample" "density" "log_density"
00070 
00071     // for "sample" mode
00072     int32_t generator_seed; // the generator_seed to initialize the generator
00073     int nsamples; // number of samples to draw
00074 
00075     // for density mode:
00076     Vec mins,maxs; // the min/max for each dimensions
00077     int samples_per_dim; // the number of samples per dimensions
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     VMatrixFromDistribution();
00086 
00087     // ******************
00088     // * Object methods *
00089     // ******************
00090 
00091 private:
00092 
00094     void build_();
00095 
00096 protected:
00097 
00099     static void declareOptions(OptionList& ol);
00100 
00101 public:
00102     // simply calls inherited::build() then build_()
00103     virtual void build();
00104 
00106     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00107 
00108     // Declares other standard object methods
00109     PLEARN_DECLARE_OBJECT(VMatrixFromDistribution);
00110 
00111     // ******************
00112     // * VMatrix methods *
00113     // ******************
00114 
00115     virtual real get(int i, int j) const;
00116     virtual void getSubRow(int i, int j, Vec v) const;
00117     virtual void getRow(int i, Vec v) const;
00118     virtual void getColumn(int i, Vec v) const;
00119     virtual void getMat(int i, int j, Mat m) const;
00120     virtual Mat toMat() const;
00121 
00122 };
00123 
00124 // Declares a few other classes and functions related to this class
00125 DECLARE_OBJECT_PTR(VMatrixFromDistribution);
00126 
00127 } // end of namespace PLearn
00128 
00129 #endif
00130 
00131 
00132 /*
00133   Local Variables:
00134   mode:c++
00135   c-basic-offset:4
00136   c-file-style:"stroustrup"
00137   c-file-offsets:((innamespace . 0)(inline-open . 0))
00138   indent-tabs-mode:nil
00139   fill-column:79
00140   End:
00141 */
00142 // 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