PLearn 0.1
IdentityModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // IdentityModule.h
00004 //
00005 // Copyright (C) 2007 Olivier Delalleau
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: Olivier Delalleau
00036 
00040 #ifndef IdentityModule_INC
00041 #define IdentityModule_INC
00042 
00043 #include <plearn_learners/online/OnlineLearningModule.h>
00044 
00045 namespace PLearn {
00046 
00047 class IdentityModule : public OnlineLearningModule
00048 {
00049     typedef OnlineLearningModule inherited;
00050 
00051 public:
00052     //#####  Public Build Options  ############################################
00053 
00054 public:
00055     //#####  Public Member Functions  #########################################
00056 
00058     // ### Make sure the implementation in the .cc
00059     // ### initializes all fields to reasonable default values.
00060     IdentityModule();
00061 
00062     // Your other public member functions go here
00063 
00065     virtual void fprop(const Vec& input, Vec& output) const;
00066 
00069     virtual void fprop(const Mat& inputs, Mat& outputs);
00070 
00071     virtual void bpropAccUpdate(const TVec<Mat*>& ports_value,
00072                                 const TVec<Mat*>& ports_gradient);
00073 
00074 
00075     /* Optional
00076        THE DEFAULT IMPLEMENTATION IN SUPER-CLASS JUST RAISES A PLERROR.
00085     virtual void bpropUpdate(const Vec& input, const Vec& output,
00086                              Vec& input_gradient,
00087                              const Vec& output_gradient,
00088                              bool accumulate=false);
00089     */
00090 
00091     /* Optional
00092        A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH
00093        JUST CALLS
00094             bpropUpdate(input, output, input_gradient, output_gradient)
00095        AND IGNORES INPUT GRADIENT.
00097     virtual void bpropUpdate(const Vec& input, const Vec& output,
00098                              const Vec& output_gradient);
00099     */
00100 
00101     /* Optional
00102        N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH
00103        RAISES A PLERROR.
00108     virtual void bbpropUpdate(const Vec& input, const Vec& output,
00109                               Vec& input_gradient,
00110                               const Vec& output_gradient,
00111                               Vec& input_diag_hessian,
00112                               const Vec& output_diag_hessian,
00113                               bool accumulate=false);
00114     */
00115 
00116     /* Optional
00117        N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS,
00118        WHICH JUST CALLS
00119             bbpropUpdate(input, output, input_gradient, output_gradient,
00120                          out_hess, in_hess)
00121        AND IGNORES INPUT HESSIAN AND INPUT GRADIENT.
00123     virtual void bbpropUpdate(const Vec& input, const Vec& output,
00124                               const Vec& output_gradient,
00125                               const Vec& output_diag_hessian);
00126     */
00127 
00128 
00132     virtual void forget();
00133 
00134 
00135     /* Optional
00136        THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS DOES NOT
00137        DO ANYTHING.
00141     virtual void finalize();
00142     */
00143 
00144     /* Optional
00145        THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS RETURNS false
00147     virtual bool bpropDoesNothing();
00148     */
00149 
00150     /* Optional
00151        Default implementation prints a warning and does nothing
00154     virtual void setLearningRate(real dynamic_learning_rate);
00155     */
00156 
00157     //#####  PLearn::Object Protocol  #########################################
00158 
00159     // Declares other standard object methods.
00160     // ### If your class is not instantiatable (it has pure virtual methods)
00161     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00162     PLEARN_DECLARE_OBJECT(IdentityModule);
00163 
00164     // Simply calls inherited::build() then build_()
00165     virtual void build();
00166 
00168     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00169 
00170 
00171 protected:
00172     //#####  Protected Member Functions  ######################################
00173 
00175     static void declareOptions(OptionList& ol);
00176 
00177 private:
00178     //#####  Private Member Functions  ########################################
00179 
00181     void build_();
00182 
00183 private:
00184     //#####  Private Data Members  ############################################
00185 
00186     // The rest of the private stuff goes here
00187 };
00188 
00189 // Declares a few other classes and functions related to this class
00190 DECLARE_OBJECT_PTR(IdentityModule);
00191 
00192 } // end of namespace PLearn
00193 
00194 #endif
00195 
00196 
00197 /*
00198   Local Variables:
00199   mode:c++
00200   c-basic-offset:4
00201   c-file-style:"stroustrup"
00202   c-file-offsets:((innamespace . 0)(inline-open . 0))
00203   indent-tabs-mode:nil
00204   fill-column:79
00205   End:
00206 */
00207 // 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