PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // NullModule.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 NullModule_INC 00041 #define NullModule_INC 00042 00043 #include <plearn_learners/online/OnlineLearningModule.h> 00044 00045 namespace PLearn { 00046 00057 class NullModule : public OnlineLearningModule 00058 { 00059 typedef OnlineLearningModule inherited; 00060 00061 public: 00062 //##### Public Build Options ############################################ 00063 00066 00067 public: 00068 //##### Public Member Functions ######################################### 00069 00071 NullModule(const string& name = "", bool call_build_ = true); 00072 00073 // Your other public member functions go here 00074 00076 virtual void fprop(const Vec& input, Vec& output) const; 00077 00078 /* Optional 00079 THE DEFAULT IMPLEMENTATION IN SUPER-CLASS JUST RAISES A PLERROR. 00088 virtual void bpropUpdate(const Vec& input, const Vec& output, 00089 Vec& input_gradient, 00090 const Vec& output_gradient, 00091 bool accumulate=false); 00092 */ 00093 00094 /* Optional 00095 A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH 00096 JUST CALLS 00097 bpropUpdate(input, output, input_gradient, output_gradient) 00098 AND IGNORES INPUT GRADIENT. 00100 virtual void bpropUpdate(const Vec& input, const Vec& output, 00101 const Vec& output_gradient); 00102 */ 00103 00104 /* Optional 00105 N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH 00106 RAISES A PLERROR. 00111 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00112 Vec& input_gradient, 00113 const Vec& output_gradient, 00114 Vec& input_diag_hessian, 00115 const Vec& output_diag_hessian, 00116 bool accumulate=false); 00117 */ 00118 00119 /* Optional 00120 N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, 00121 WHICH JUST CALLS 00122 bbpropUpdate(input, output, input_gradient, output_gradient, 00123 out_hess, in_hess) 00124 AND IGNORES INPUT HESSIAN AND INPUT GRADIENT. 00126 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00127 const Vec& output_gradient, 00128 const Vec& output_diag_hessian); 00129 */ 00130 00131 00135 virtual void forget(); 00136 00137 00138 /* Optional 00139 THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS DOES NOT 00140 DO ANYTHING. 00144 virtual void finalize(); 00145 */ 00146 00147 /* Optional 00148 THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS RETURNS false 00150 virtual bool bpropDoesNothing(); 00151 */ 00152 00153 /* Optional 00154 Default implementation prints a warning and does nothing 00157 virtual void setLearningRate(real dynamic_learning_rate); 00158 */ 00159 00161 virtual void fprop(const TVec<Mat*>& ports_value); 00162 00164 virtual void bpropAccUpdate(const TVec<Mat*>& ports_value, 00165 const TVec<Mat*>& ports_gradient); 00166 00168 virtual const TVec<string>& getPorts(); 00169 00171 virtual const TMat<int>& getPortSizes(); 00172 00173 00174 //##### PLearn::Object Protocol ######################################### 00175 00176 // Declares other standard object methods. 00177 // ### If your class is not instantiatable (it has pure virtual methods) 00178 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00179 PLEARN_DECLARE_OBJECT(NullModule); 00180 00181 // Simply calls inherited::build() then build_() 00182 virtual void build(); 00183 00185 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00186 00187 00188 protected: 00189 //##### Protected Member Functions ###################################### 00190 00192 static void declareOptions(OptionList& ol); 00193 00194 private: 00195 //##### Private Member Functions ######################################## 00196 00198 void build_(); 00199 00200 private: 00201 //##### Private Data Members ############################################ 00202 00203 // The rest of the private stuff goes here 00204 }; 00205 00206 // Declares a few other classes and functions related to this class 00207 DECLARE_OBJECT_PTR(NullModule); 00208 00209 } // end of namespace PLearn 00210 00211 #endif 00212 00213 00214 /* 00215 Local Variables: 00216 mode:c++ 00217 c-basic-offset:4 00218 c-file-style:"stroustrup" 00219 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00220 indent-tabs-mode:nil 00221 fill-column:79 00222 End: 00223 */ 00224 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :