PLearn 0.1
ForwardModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ForwardModule.h
00004 //
00005 // Copyright (C) 2007 Jerome Louradour
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: Jerome Louradour
00036 
00040 #ifndef ForwardModule_INC
00041 #define ForwardModule_INC
00042 
00043 #include <plearn_learners/online/OnlineLearningModule.h>
00044 
00045 namespace PLearn {
00046 
00047 class ForwardModule : public OnlineLearningModule
00048 {
00049     typedef OnlineLearningModule inherited;
00050 
00051 public:
00052 
00053     //#####  Public Build Options  ############################################
00054 
00055     TVec< PP<OnlineLearningModule> > modules;
00056     string forward_to;
00057     bool forget_all;
00058 
00059 public:
00060     //#####  Public Member Functions  #########################################
00061 
00063     ForwardModule(const string& the_name = "", bool call_build_ = false);
00064 
00065     // Your other public member functions go here
00066 
00079     void fprop(const TVec<Mat*>& ports_value);
00080 
00102     virtual void bpropAccUpdate(const TVec<Mat*>& ports_value,
00103                                 const TVec<Mat*>& ports_gradient);
00104 
00108     virtual void forget();
00109 
00110 
00114     virtual void finalize();
00115 
00117     virtual bool bpropDoesNothing();
00118 
00121     virtual void setLearningRate(real dynamic_learning_rate);
00122 
00126     virtual const TVec<string>& getPorts();
00127 
00139     virtual const TMat<int>& getPortSizes();
00140 
00141     //#####  PLearn::Object Protocol  #########################################
00142 
00143     // Declares other standard object methods.
00144     // ### If your class is not instantiatable (it has pure virtual methods)
00145     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00146     PLEARN_DECLARE_OBJECT(ForwardModule);
00147 
00148     // Simply calls inherited::build() then build_()
00149     virtual void build();
00150 
00152     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00153 
00154 
00155 protected:
00156 
00158     int current;
00159 
00160     //#####  Protected Member Functions  ######################################
00161 
00163     static void declareOptions(OptionList& ol);
00164 
00165 private:
00166     //#####  Private Member Functions  ########################################
00167 
00169     void build_();
00170 
00171 private:
00172     //#####  Private Data Members  ############################################
00173 
00174     // The rest of the private stuff goes here
00175 };
00176 
00177 // Declares a few other classes and functions related to this class
00178 DECLARE_OBJECT_PTR(ForwardModule);
00179 
00180 } // end of namespace PLearn
00181 
00182 #endif
00183 
00184 
00185 /*
00186   Local Variables:
00187   mode:c++
00188   c-basic-offset:4
00189   c-file-style:"stroustrup"
00190   c-file-offsets:((innamespace . 0)(inline-open . 0))
00191   indent-tabs-mode:nil
00192   fill-column:79
00193   End:
00194 */
00195 // 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