PLearn 0.1
RBMSparse1DMatrixConnection.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMSparse1DMatrixConnection.h
00004 //
00005 // Copyright (C) 2008 Jerome Louradour
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: Jerome Louradour
00036 
00040 #ifndef RBMSparse1DMatrixConnection_INC
00041 #define RBMSparse1DMatrixConnection_INC
00042 
00043 #include "RBMMatrixConnection.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 
00053 class RBMSparse1DMatrixConnection: public RBMMatrixConnection
00054 {
00055     typedef RBMMatrixConnection inherited;
00056 
00057 public:
00058     //#####  Public Build Options  ############################################
00059 
00060     int filter_size;
00061 
00062     bool enforce_positive_weights;
00063 
00064     //#####  Learned Options  #################################################
00065 
00066     int step_size;
00067 
00068 public:
00069     //#####  Public Member Functions  #########################################
00070 
00072     RBMSparse1DMatrixConnection( real the_learning_rate=0 );
00073 
00074     // Your other public member functions go here
00075     virtual void accumulatePosStats( const Mat& down_values,
00076                                      const Mat& up_values );
00077 
00078     virtual void accumulateNegStats( const Mat& down_values,
00079                                      const Mat& up_values );
00080 
00084     virtual void computeProducts(int start, int length,
00085                                  Mat& activations,
00086                                  bool accumulate=false ) const;
00087 
00088 
00091     virtual void fprop(const Vec& input, const Mat& rbm_weights,
00092                        Vec& output) const;
00093 
00094     virtual void bpropUpdate(const Mat& inputs, const Mat& outputs,
00095                              Mat& input_gradients,
00096                              const Mat& output_gradients,
00097                              bool accumulate = false);
00098 
00099     virtual void bpropAccUpdate(const TVec<Mat*>& ports_value,
00100                                 const TVec<Mat*>& ports_gradient);
00101 
00102     virtual void update( const Mat& pos_down_values,
00103                          const Mat& pos_up_values,
00104                          const Mat& neg_down_values,
00105                          const Mat& neg_up_values);
00106 
00110     virtual void forget();
00111 
00113     virtual int nParameters() const;
00114 
00115     virtual Mat getWeights() const;
00116 
00117     // Declares other standard object methods.
00118     PLEARN_DECLARE_OBJECT(RBMSparse1DMatrixConnection);
00119 
00120     // Simply calls inherited::build() then build_()
00121     virtual void build();
00122 
00123 protected:
00124     //#####  Protected Member Functions  ######################################
00126     static void declareOptions(OptionList& ol);
00127 
00129     static void declareMethods(RemoteMethodMap& rmm);
00130 
00131 private:
00132     //#####  Private Member Functions  ########################################
00133 
00135     void build_();
00136 
00137 private:
00138     //#####  Private Data Members  ############################################
00139 
00140     // The rest of the private stuff goes here
00141     int filterStart(int idx) const;
00142     int filterSize(int idx) const;
00143 };
00144 
00145 // Declares a few other classes and functions related to this class
00146 DECLARE_OBJECT_PTR(RBMSparse1DMatrixConnection);
00147 
00148 } // end of namespace PLearn
00149 
00150 #endif
00151 
00152 
00153 /*
00154   Local Variables:
00155   mode:c++
00156   c-basic-offset:4
00157   c-file-style:"stroustrup"
00158   c-file-offsets:((innamespace . 0)(inline-open . 0))
00159   indent-tabs-mode:nil
00160   fill-column:79
00161   End:
00162 */
00163 // 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