PLearn 0.1
DEPRECATED/RBMMixedLayer.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMMixedLayer.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 RBMMixedLayer_INC
00041 #define RBMMixedLayer_INC
00042 
00043 #include "RBMLayer.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00054 class RBMMixedLayer: public RBMLayer
00055 {
00056     typedef RBMLayer inherited;
00057 
00058 public:
00059     //#####  Public Build Options  ############################################
00060 
00062     TVec< PP<RBMLayer> > sub_layers;
00063 
00064 
00065 public:
00066     //#####  Public Member Functions  #########################################
00067 
00069     RBMMixedLayer();
00070 
00072     RBMMixedLayer( TVec< PP<RBMLayer> > the_sub_layers );
00073 
00074 
00075     // Your other public member functions go here
00076 
00079     virtual void getUnitActivations( int i, PP<RBMParameters> rbmp,
00080                                      int offset=0 );
00081 
00084     virtual void getAllActivations( PP<RBMParameters> rbmp, int offset=0 ) ;
00085 
00087     virtual void generateSample() ;
00088 
00090     virtual void computeExpectation() ;
00091 
00093     virtual void bpropUpdate(const Vec& input, const Vec& output,
00094                              Vec& input_gradient, const Vec& output_gradient);
00095 
00096     //#####  PLearn::Object Protocol  #########################################
00097 
00098     // Declares other standard object methods.
00099     PLEARN_DECLARE_OBJECT(RBMMixedLayer);
00100 
00101     // Simply calls inherited::build() then build_()
00102     virtual void build();
00103 
00105     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00106 
00107 protected:
00108 
00110     TVec<int> init_positions;
00111 
00113     TVec<int> layer_of_unit;
00114 
00116     int n_layers;
00117 
00118     //#####  Not Options  #####################################################
00119 
00120 protected:
00121     //#####  Protected Member Functions  ######################################
00122 
00124     static void declareOptions(OptionList& ol);
00125 
00126 private:
00127     //#####  Private Member Functions  ########################################
00128 
00130     void build_();
00131 
00132 private:
00133     //#####  Private Data Members  ############################################
00134 
00135     // The rest of the private stuff goes here
00136 };
00137 
00138 // Declares a few other classes and functions related to this class
00139 DECLARE_OBJECT_PTR(RBMMixedLayer);
00140 
00141 } // end of namespace PLearn
00142 
00143 #endif
00144 
00145 
00146 /*
00147   Local Variables:
00148   mode:c++
00149   c-basic-offset:4
00150   c-file-style:"stroustrup"
00151   c-file-offsets:((innamespace . 0)(inline-open . 0))
00152   indent-tabs-mode:nil
00153   fill-column:79
00154   End:
00155 */
00156 // 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