PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // MaxSubsampling2DModule.h 00004 // 00005 // Copyright (C) 2007 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 // Authors: Pascal Lamblin 00036 00040 #ifndef MaxSubsampling2DModule_INC 00041 #define MaxSubsampling2DModule_INC 00042 00043 #include <plearn_learners/online/OnlineLearningModule.h> 00044 00045 namespace PLearn { 00046 00051 class MaxSubsampling2DModule : public OnlineLearningModule 00052 { 00053 typedef OnlineLearningModule inherited; 00054 00055 public: 00056 //##### Public Build Options ############################################ 00057 00060 00062 int n_input_images; 00063 00065 int input_images_length; 00066 00068 int input_images_width; 00069 00071 int kernel_length; 00072 00074 int kernel_width; 00075 00076 //##### Not options ##################################################### 00078 int output_images_length; 00079 00081 int output_images_width; 00082 00084 int input_images_size; 00085 00087 int output_images_size; 00088 00089 00090 00091 public: 00092 //##### Public Member Functions ######################################### 00093 00095 // ### Make sure the implementation in the .cc 00096 // ### initializes all fields to reasonable default values. 00097 MaxSubsampling2DModule(); 00098 00099 // Your other public member functions go here 00100 00113 void fprop(const TVec<Mat*>& ports_value); 00114 00136 virtual void bpropAccUpdate(const TVec<Mat*>& ports_value, 00137 const TVec<Mat*>& ports_gradient); 00138 00139 00143 virtual void forget(); 00144 00147 virtual void setLearningRate(real dynamic_learning_rate); 00148 00152 virtual const TVec<string>& getPorts(); 00153 00165 virtual const TMat<int>& getPortSizes(); 00166 00167 //##### PLearn::Object Protocol ######################################### 00168 00169 // Declares other standard object methods. 00170 // ### If your class is not instantiatable (it has pure virtual methods) 00171 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00172 PLEARN_DECLARE_OBJECT(MaxSubsampling2DModule); 00173 00174 // Simply calls inherited::build() then build_() 00175 virtual void build(); 00176 00178 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00179 00180 00181 protected: 00182 //##### Protected Member Functions ###################################### 00183 00185 static void declareOptions(OptionList& ol); 00186 00187 private: 00188 //##### Private Member Functions ######################################## 00189 00191 void build_(); 00192 00193 private: 00194 //##### Private Data Members ############################################ 00195 00196 // The rest of the private stuff goes here 00197 00199 TVec<string> ports; 00200 }; 00201 00202 // Declares a few other classes and functions related to this class 00203 DECLARE_OBJECT_PTR(MaxSubsampling2DModule); 00204 00205 } // end of namespace PLearn 00206 00207 #endif 00208 00209 00210 /* 00211 Local Variables: 00212 mode:c++ 00213 c-basic-offset:4 00214 c-file-style:"stroustrup" 00215 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00216 indent-tabs-mode:nil 00217 fill-column:79 00218 End: 00219 */ 00220 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :