PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // TanhModule.h 00004 // 00005 // Copyright (C) 2005 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 /* ******************************************************* 00036 * $Id: TanhModule.h,v 1.1 2005/11/30 04:36:17 lamblinp Exp $ 00037 ******************************************************* */ 00038 00039 // Authors: Pascal Lamblin 00040 00044 #ifndef TanhModule_INC 00045 #define TanhModule_INC 00046 00047 #include <plearn/base/Object.h> 00048 #include "OnlineLearningModule.h" 00049 00050 namespace PLearn { 00051 00059 class TanhModule : public OnlineLearningModule 00060 { 00061 typedef OnlineLearningModule inherited; 00062 00063 public: 00064 //##### Public Build Options ############################################ 00065 real in_scale; 00066 real ex_scale; 00067 00068 public: 00069 //##### Public Member Functions ######################################### 00070 00072 TanhModule(); 00073 00074 // Your other public member functions go here 00075 00076 virtual void fprop(const Vec& input, Vec& output) const; 00077 virtual void fprop(const Mat& inputs, Mat& outputs); 00078 00079 virtual void bpropUpdate(const Vec& input, const Vec& output, 00080 const Vec& output_gradient); 00081 00082 virtual void bpropUpdate(const Mat& inputs, const Mat& outputs, 00083 Mat& input_gradients, const Mat& output_gradients, 00084 bool accumulate=false); 00085 00086 virtual void bpropUpdate(const Vec& input, const Vec& output, 00087 Vec& input_gradient, const Vec& output_gradient, 00088 bool accumulate=false); 00089 00090 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00091 const Vec& output_gradient, 00092 const Vec& output_diag_hessian); 00093 00094 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00095 Vec& input_gradient, 00096 const Vec& output_gradient, 00097 Vec& input_diag_hessian, 00098 const Vec& output_diag_hessian, 00099 bool accumulate=false); 00100 00101 virtual void forget(); 00102 00103 //##### PLearn::Object Protocol ######################################### 00104 00105 // Declares other standard object methods. 00106 PLEARN_DECLARE_OBJECT(TanhModule); 00107 00108 // Simply calls inherited::build() then build_() 00109 virtual void build(); 00110 00112 // (PLEASE IMPLEMENT IN .cc) 00113 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00114 00115 protected: 00116 //##### Protected Options ############################################### 00117 00118 protected: 00119 //##### Protected Member Functions ###################################### 00120 00122 static void declareOptions(OptionList& ol); 00123 00124 private: 00125 //##### Private Member Functions ######################################## 00126 00128 void build_(); 00129 00130 private: 00131 //##### Private Data Members ############################################ 00132 00133 // The rest of the private stuff goes here 00134 }; 00135 00136 // Declares a few other classes and functions related to this class 00137 DECLARE_OBJECT_PTR(TanhModule); 00138 00139 } // end of namespace PLearn 00140 00141 #endif 00142 00143 00144 /* 00145 Local Variables: 00146 mode:c++ 00147 c-basic-offset:4 00148 c-file-style:"stroustrup" 00149 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00150 indent-tabs-mode:nil 00151 fill-column:79 00152 End: 00153 */ 00154 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :