PLearn 0.1
DEPRECATED/RBMTruncExpLayer.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMTruncExpLayer.h
00004 //
00005 // Copyright (C) 2006 Dan Popovici & Pascal Lamblin
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: Dan Popovici & Pascal Lamblin
00036 
00040 #ifndef RBMTruncExpLayer_INC
00041 #define RBMTruncExpLayer_INC
00042 
00043 #include "RBMLayer.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00054 class RBMTruncExpLayer: public RBMLayer
00055 {
00056     typedef RBMLayer inherited;
00057 
00058 public:
00059     //#####  Public Build Options  ############################################
00060 
00061 
00062 
00063 public:
00064     //#####  Public Member Functions  #########################################
00065 
00067     RBMTruncExpLayer();
00068 
00070     RBMTruncExpLayer( int the_size );
00071 
00072 
00073     // Your other public member functions go here
00074 
00077     virtual void getUnitActivations( int i, PP<RBMParameters> rbmp,
00078                                      int offset=0 );
00079 
00082     virtual void getAllActivations( PP<RBMParameters> rbmp, int offset=0 ) ;
00083 
00085     virtual void generateSample() ;
00086 
00088     virtual void computeExpectation() ;
00089 
00091     virtual void bpropUpdate(const Vec& input, const Vec& output,
00092                              Vec& input_gradient, const Vec& output_gradient);
00093 
00094 
00095     //#####  PLearn::Object Protocol  #########################################
00096 
00097     // Declares other standard object methods.
00098     PLEARN_DECLARE_OBJECT(RBMTruncExpLayer);
00099 
00100     // Simply calls inherited::build() then build_()
00101     virtual void build();
00102 
00104     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00105 
00106 protected:
00107     //#####  Not Options  #####################################################
00108 
00109 protected:
00110     //#####  Protected Member Functions  ######################################
00111 
00113     static void declareOptions(OptionList& ol);
00114 
00115 private:
00116     //#####  Private Member Functions  ########################################
00117 
00119     void build_();
00120 
00121 private:
00122     //#####  Private Data Members  ############################################
00123 
00124     // The rest of the private stuff goes here
00125 };
00126 
00127 // Declares a few other classes and functions related to this class
00128 DECLARE_OBJECT_PTR(RBMTruncExpLayer);
00129 
00130 } // end of namespace PLearn
00131 
00132 #endif
00133 
00134 
00135 /*
00136   Local Variables:
00137   mode:c++
00138   c-basic-offset:4
00139   c-file-style:"stroustrup"
00140   c-file-offsets:((innamespace . 0)(inline-open . 0))
00141   indent-tabs-mode:nil
00142   fill-column:79
00143   End:
00144 */
00145 // 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