PLearn 0.1
RBMMixedConnection.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMMixedConnection.h
00004 //
00005 // Copyright (C) 2006 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: Pascal Lamblin
00036 
00040 #ifndef RBMMixedConnection_INC
00041 #define RBMMixedConnection_INC
00042 
00043 #include "RBMConnection.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 
00056 class RBMMixedConnection: public RBMConnection
00057 {
00058     typedef RBMConnection inherited;
00059 
00060 public:
00061     //#####  Public Build Options  ############################################
00062 
00063     //#####  Learned Options  #################################################
00064 
00066     TMat< PP<RBMConnection> > sub_connections;
00067 
00068     //#####  Not Options  #####################################################
00069 
00070 public:
00071     //#####  Public Member Functions  #########################################
00072 
00074     RBMMixedConnection();
00075 
00076     // Your other public member functions go here
00077 
00079     virtual void setLearningRate( real the_learning_rate );
00081     virtual void setMomentum( real the_momentum );
00082 
00083     virtual void setAsUpInput( const Vec& input ) const;
00084     virtual void setAsDownInput( const Vec& input ) const;
00085 
00086     virtual void setAsUpInputs( const Mat& inputs ) const;
00087 
00088     virtual void setAsDownInputs( const Mat& input ) const;
00089 
00091     virtual void accumulatePosStats( const Vec& down_values,
00092                                      const Vec& up_values );
00093 
00094     virtual void accumulatePosStats( const Mat& down_values,
00095                                      const Mat& up_values )
00096     {
00097         PLASSERT_MSG( false, "Not implemented" );
00098     }
00099 
00101     virtual void accumulateNegStats( const Vec& down_values,
00102                                      const Vec& up_values );
00103 
00104     virtual void accumulateNegStats( const Mat& down_values,
00105                                      const Mat& up_values )
00106     {
00107         PLASSERT_MSG( false, "Not implemented" );
00108     }
00109 
00111     virtual void update();
00112 
00115     virtual void update( const Vec& pos_down_values,
00116                          const Vec& pos_up_values,
00117                          const Vec& neg_down_values,
00118                          const Vec& neg_up_values );
00119 
00121     virtual void update( const Mat& pos_down_values,
00122                          const Mat& pos_up_values,
00123                          const Mat& neg_down_values,
00124                          const Mat& neg_up_values);
00125 
00127     virtual void clearStats();
00128 
00132     virtual void computeProduct( int start, int length,
00133                                  const Vec& activations,
00134                                  bool accumulate=false ) const;
00135 
00137     virtual void computeProducts(int start, int length,
00138                                  Mat& activations,
00139                                  bool accumulate=false ) const;
00140 
00151     // virtual void bpropUpdate(const Vec& input, const Vec& output,
00152     //                          const Vec& output_gradient);
00153 
00155     virtual void bpropUpdate(const Vec& input, const Vec& output,
00156                              Vec& input_gradient,
00157                              const Vec& output_gradient,
00158                              bool accumulate=false);
00159 
00161     virtual void bpropUpdate(const Mat& inputs, const Mat& outputs,
00162                              Mat& input_gradients,
00163                              const Mat& output_gradients,
00164                              bool accumulate=false);
00165 
00166     virtual void bpropAccUpdate(const TVec<Mat*>& ports_value,
00167                                 const TVec<Mat*>& ports_gradient);
00168 
00172     virtual void forget();
00173 
00178     // virtual void finalize();
00179 
00181     virtual int nParameters() const;
00182 
00188     virtual Vec makeParametersPointHere(const Vec& global_parameters);
00189 
00190     //#####  PLearn::Object Protocol  #########################################
00191 
00192     // Declares other standard object methods.
00193     PLEARN_DECLARE_OBJECT(RBMMixedConnection);
00194 
00195     // Simply calls inherited::build() then build_()
00196     virtual void build();
00197 
00199     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00200 
00201 protected:
00202 
00204     TVec<int> up_init_positions;
00205 
00207     TVec<int> up_block_sizes;
00208 
00210     TVec<int> down_init_positions;
00211 
00213     TVec<int> down_block_sizes;
00214 
00215     TVec<int> row_of;
00216     TVec<int> col_of;
00217 
00219     int n_up_blocks;
00220 
00222     int n_down_blocks;
00223 
00224 
00225 protected:
00226     //#####  Protected Member Functions  ######################################
00228     static void declareOptions(OptionList& ol);
00229 
00230 private:
00231     //#####  Private Member Functions  ########################################
00232 
00234     void build_();
00235 
00236 private:
00237     //#####  Private Data Members  ############################################
00238 
00239     // The rest of the private stuff goes here
00240 };
00241 
00242 // Declares a few other classes and functions related to this class
00243 DECLARE_OBJECT_PTR(RBMMixedConnection);
00244 
00245 } // end of namespace PLearn
00246 
00247 #endif
00248 
00249 
00250 /*
00251   Local Variables:
00252   mode:c++
00253   c-basic-offset:4
00254   c-file-style:"stroustrup"
00255   c-file-offsets:((innamespace . 0)(inline-open . 0))
00256   indent-tabs-mode:nil
00257   fill-column:79
00258   End:
00259 */
00260 // 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