PLearn 0.1
MatrixModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // MatrixModule.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 MatrixModule_INC
00041 #define MatrixModule_INC
00042 
00043 #include <plearn_learners/online/OnlineLearningModule.h>
00044 
00045 namespace PLearn {
00046 
00057 class MatrixModule : public OnlineLearningModule
00058 {
00059     typedef OnlineLearningModule inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00064     Mat data;
00065     Mat data_gradient;
00066 
00067 public:
00068     //#####  Public Member Functions  #########################################
00069 
00074     MatrixModule(const string& the_name = "", bool call_build_ = false);
00075 
00076     // Your other public member functions go here
00077 
00080     void setData(const Mat& the_data);
00081 
00083     Mat& getData();
00084 
00086     virtual void fprop(const Vec& input, Vec& output) const;
00087 
00088 
00089     /* Optional
00090        THE DEFAULT IMPLEMENTATION IN SUPER-CLASS JUST RAISES A PLERROR.
00099     virtual void bpropUpdate(const Vec& input, const Vec& output,
00100                              Vec& input_gradient,
00101                              const Vec& output_gradient,
00102                              bool accumulate=false);
00103     */
00104 
00105     /* Optional
00106        A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH
00107        JUST CALLS
00108             bpropUpdate(input, output, input_gradient, output_gradient)
00109        AND IGNORES INPUT GRADIENT.
00111     virtual void bpropUpdate(const Vec& input, const Vec& output,
00112                              const Vec& output_gradient);
00113     */
00114 
00115     /* Optional
00116        N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH
00117        RAISES A PLERROR.
00122     virtual void bbpropUpdate(const Vec& input, const Vec& output,
00123                               Vec& input_gradient,
00124                               const Vec& output_gradient,
00125                               Vec& input_diag_hessian,
00126                               const Vec& output_diag_hessian,
00127                               bool accumulate=false);
00128     */
00129 
00130     /* Optional
00131        N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS,
00132        WHICH JUST CALLS
00133             bbpropUpdate(input, output, input_gradient, output_gradient,
00134                          out_hess, in_hess)
00135        AND IGNORES INPUT HESSIAN AND INPUT GRADIENT.
00137     virtual void bbpropUpdate(const Vec& input, const Vec& output,
00138                               const Vec& output_gradient,
00139                               const Vec& output_diag_hessian);
00140     */
00141 
00142 
00146     virtual void forget();
00147 
00148 
00149     /* Optional
00150        THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS DOES NOT
00151        DO ANYTHING.
00155     virtual void finalize();
00156     */
00157 
00158     /* Optional
00159        THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS RETURNS false
00161     virtual bool bpropDoesNothing();
00162     */
00163 
00164     /* Optional
00165        Default implementation prints a warning and does nothing
00168     virtual void setLearningRate(real dynamic_learning_rate);
00169     */
00170 
00173     virtual void fprop(const TVec<Mat*>& ports_value);
00174 
00178     virtual void bpropAccUpdate(const TVec<Mat*>& ports_value,
00179                                 const TVec<Mat*>& ports_gradient);
00180 
00182     virtual const TVec<string>& getPorts();
00183 
00185     virtual const TMat<int>& getPortSizes();
00186 
00190     void setGradientTo(real g);
00191 
00192     //#####  PLearn::Object Protocol  #########################################
00193 
00194     // Declares other standard object methods.
00195     // ### If your class is not instantiatable (it has pure virtual methods)
00196     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00197     PLEARN_DECLARE_OBJECT(MatrixModule);
00198 
00199     // Simply calls inherited::build() then build_()
00200     virtual void build();
00201 
00203     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00204 
00205 protected:
00206     //#####  Protected Member Functions  ######################################
00207 
00209     static void declareOptions(OptionList& ol);
00210 
00211 private:
00212     //#####  Private Member Functions  ########################################
00213 
00215     void build_();
00216 
00217 private:
00218     //#####  Private Data Members  ############################################
00219 
00220     // The rest of the private stuff goes here
00221 };
00222 
00223 // Declares a few other classes and functions related to this class
00224 DECLARE_OBJECT_PTR(MatrixModule);
00225 
00226 } // end of namespace PLearn
00227 
00228 #endif
00229 
00230 
00231 /*
00232   Local Variables:
00233   mode:c++
00234   c-basic-offset:4
00235   c-file-style:"stroustrup"
00236   c-file-offsets:((innamespace . 0)(inline-open . 0))
00237   indent-tabs-mode:nil
00238   fill-column:79
00239   End:
00240 */
00241 // 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