PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // RBMDistribution.h 00004 // 00005 // Copyright (C) 2008 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 // Authors: Olivier Delalleau 00036 00040 #ifndef RBMDistribution_INC 00041 #define RBMDistribution_INC 00042 00043 #include <plearn_learners/distributions/UnconditionalDistribution.h> 00044 #include <plearn_learners/online/ModuleLearner.h> 00045 #include <plearn_learners/online/RBMModule.h> 00046 00047 namespace PLearn { 00048 00059 class RBMDistribution : public UnconditionalDistribution 00060 { 00061 typedef UnconditionalDistribution inherited; 00062 00063 public: 00064 //##### Public Build Options ############################################ 00065 00066 PP<RBMModule> rbm; 00067 00068 real n_gibbs_chains; 00069 VMat sample_data; 00070 bool unnormalized_density; 00071 00072 public: 00073 //##### Public Member Functions ######################################### 00074 00076 RBMDistribution(); 00077 00078 00079 //##### UnconditionalDistribution Member Functions ###################### 00080 00082 virtual real log_density(const Vec& x) const; 00083 00085 virtual real survival_fn(const Vec& y) const; 00086 00088 virtual real cdf(const Vec& y) const; 00089 00091 virtual void expectation(Vec& mu) const; 00092 00094 virtual void variance(Mat& cov) const; 00095 00097 virtual void generate(Vec& y) const; 00098 00100 void generateN(const Mat& Y) const; 00101 00104 virtual void resetGenerator(long g_seed); 00105 00106 // ### These methods may be overridden for efficiency purpose: 00107 /* 00109 virtual real density(const Vec& y) const; 00110 */ 00111 00112 00113 //##### PLearner Member Functions ####################################### 00114 00115 // ### Default version of inputsize returns learner->inputsize() 00116 // ### If this is not appropriate, you should uncomment this and define 00117 // ### it properly in the .cc 00118 // virtual int inputsize() const; 00119 00123 virtual void forget(); 00124 00128 // ### You may remove this method if your distribution does not 00129 // ### implement it. 00130 virtual void train(); 00131 00132 00133 //##### PLearn::Object Protocol ######################################### 00134 00135 // Declares other standard object methods. 00136 // ### If your class is not instantiatable (it has pure virtual methods) 00137 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 00138 PLEARN_DECLARE_OBJECT(RBMDistribution); 00139 00140 // Simply calls inherited::build() then build_() 00141 virtual void build(); 00142 00144 // (PLEASE IMPLEMENT IN .cc) 00145 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00146 00147 protected: 00148 00150 PP<ModuleLearner> learner; 00151 00153 TVec<Mat*> ports_val; 00154 00156 mutable Mat work1, work2, work3; 00157 00159 mutable Vec workv1; 00160 00161 //##### Protected Options ############################################### 00162 00163 // ### Declare protected option fields (such as learned parameters) here 00164 // ... 00165 00166 protected: 00167 //##### Protected Member Functions ###################################### 00168 00170 static void declareOptions(OptionList& ol); 00171 00172 private: 00173 //##### Private Member Functions ######################################## 00174 00176 // (PLEASE IMPLEMENT IN .cc) 00177 void build_(); 00178 00179 private: 00180 //##### Private Data Members ############################################ 00181 00182 // The rest of the private stuff goes here 00183 }; 00184 00185 // Declares a few other classes and functions related to this class 00186 DECLARE_OBJECT_PTR(RBMDistribution); 00187 00188 } // end of namespace PLearn 00189 00190 #endif 00191 00192 00193 /* 00194 Local Variables: 00195 mode:c++ 00196 c-basic-offset:4 00197 c-file-style:"stroustrup" 00198 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00199 indent-tabs-mode:nil 00200 fill-column:79 00201 End: 00202 */ 00203 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :