PLearn 0.1
RBMJointGenericParameters.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMJointGenericParameters.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 RBMJointGenericParameters_INC
00041 #define RBMJointGenericParameters_INC
00042 
00043 #include "RBMGenericParameters.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 //class RBMLayer;
00049 
00056 class RBMJointGenericParameters: public RBMGenericParameters
00057 {
00058     typedef RBMGenericParameters inherited;
00059 
00060 public:
00061     //#####  Public Build Options  ############################################
00062 
00064     PP<RBMGenericParameters> target_params;
00065 
00067     PP<RBMGenericParameters> cond_params;
00068 
00069 
00070 public:
00071     //#####  Public Member Functions  #########################################
00072 
00074     RBMJointGenericParameters( real the_learning_rate=0 );
00075 
00077     RBMJointGenericParameters( PP<RBMGenericParameters>& the_target_params,
00078                                PP<RBMGenericParameters>& the_cond_params,
00079                                real the_learning_rate=0 );
00080 
00081     // Your other public member functions go here
00082 
00084     virtual void setAsUpInput( const Vec& input ) const;
00085 
00087     virtual void setAsDownInput( const Vec& input ) const;
00088 
00090     virtual void setAsCondInput( const Vec& input ) const;
00091 
00095     virtual void computeUnitActivations( int start, int length,
00096                                          const Vec& activations ) const;
00097 
00099     virtual void fprop(const Vec& input, Vec& output) const;
00100 
00111     // virtual void bpropUpdate(const Vec& input, const Vec& output,
00112     //                          const Vec& output_gradient);
00113 
00116     virtual void bpropUpdate(const Vec& input, const Vec& output,
00117                              Vec& input_gradient,
00118                              const Vec& output_gradient);
00119 
00123     virtual void forget();
00124 
00129     // virtual void finalize();
00130 
00131     //#####  PLearn::Object Protocol  #########################################
00132 
00133     // Declares other standard object methods.
00134     PLEARN_DECLARE_OBJECT(RBMJointGenericParameters);
00135 
00136     // Simply calls inherited::build() then build_()
00137     virtual void build();
00138 
00140     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00141 
00142 protected:
00143     //#####  Learned Options  #################################################
00144 
00145     //#####  Not Options  #####################################################
00146 
00151     mutable bool target_given_cond;
00152 
00154     int target_size;
00155 
00157     int cond_size;
00158 
00160     mutable Vec out_act;
00161 
00162 protected:
00163     //#####  Protected Member Functions  ######################################
00167     virtual void computeLinearUnitActivations( int i, const Vec& activations )
00168         const;
00169 
00173     virtual void computeQuadraticUnitActivations( int i,
00174                                                   const Vec& activations )
00175         const;
00176 
00178     static void declareOptions(OptionList& ol);
00179 
00180 private:
00181     //#####  Private Member Functions  ########################################
00182 
00185     void build_units_types();
00186 
00188     void build_();
00189 
00190 private:
00191     //#####  Private Data Members  ############################################
00192 
00193     // The rest of the private stuff goes here
00194 };
00195 
00196 // Declares a few other classes and functions related to this class
00197 DECLARE_OBJECT_PTR(RBMJointGenericParameters);
00198 
00199 } // end of namespace PLearn
00200 
00201 #endif
00202 
00203 
00204 /*
00205   Local Variables:
00206   mode:c++
00207   c-basic-offset:4
00208   c-file-style:"stroustrup"
00209   c-file-offsets:((innamespace . 0)(inline-open . 0))
00210   indent-tabs-mode:nil
00211   fill-column:79
00212   End:
00213 */
00214 // 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