PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // MultiMaxVariable.h 00004 // 00005 // Copyright (C) 2007 Simon Lemieux, Pascal Vincent 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: Simon Lemieux, Pascal Vincent 00036 00040 #ifndef MultiMaxVariable_INC 00041 #define MultiMaxVariable_INC 00042 00043 #include <plearn/var/UnaryVariable.h> 00044 00045 namespace PLearn { 00046 using namespace std; 00047 00065 class MultiMaxVariable : public UnaryVariable 00066 { 00067 typedef UnaryVariable inherited; 00068 00069 public: 00070 //##### Public Build Options ############################################ 00071 00074 00076 //TODO : peut-etre rendre ça private et faire un get set qtion de checker si 00077 // les sizes ont du sens... ou sinon valider qqpart ailleurs que la somme des 00078 // groupsize's donne bien le width de la variable 00079 TVec<int> groupsizes; 00080 char computation_type; 00081 int groupsize; 00082 00083 public: 00084 //##### Public Member Functions ######################################### 00085 00087 MultiMaxVariable() 00088 :computation_type('S'), 00089 groupsize(-1) 00090 {} 00091 00092 00093 // ### If your class has parameters, you probably want a constructor that 00094 // ### initializes them 00095 MultiMaxVariable(Variable* input, TVec<int> groupsizes, char computation_type='S'); 00096 MultiMaxVariable(Variable* input, int groupsizes, char computation_type='S'); 00097 00098 // Your other public member functions go here 00099 00100 //##### PLearn::Variable methods ######################################### 00101 // (PLEASE IMPLEMENT IN .cc) 00102 virtual void recomputeSize(int& l, int& w) const; 00103 virtual void fprop(); 00104 virtual void bprop(); 00105 00106 // ### These ones are not always implemented 00107 // virtual void bbprop(); 00108 // virtual void symbolicBprop(); 00109 // virtual void rfprop(); 00110 00111 //##### PLearn::Object Protocol ######################################### 00112 00113 // Declares other standard object methods. 00114 // ### If your class is not instantiatable (it has pure virtual methods) 00115 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00116 PLEARN_DECLARE_OBJECT(MultiMaxVariable); 00117 00118 // Simply calls inherited::build() then build_() 00119 virtual void build(); 00120 00122 // (PLEASE IMPLEMENT IN .cc) 00123 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00124 00125 protected: 00126 //##### Protected Options ############################################### 00127 00128 // ### Declare protected option fields (such as learned parameters) here 00129 // ... 00130 00131 protected: 00132 //##### Protected Member Functions ###################################### 00133 00135 // (PLEASE IMPLEMENT IN .cc) 00136 static void declareOptions(OptionList& ol); 00137 00138 private: 00139 //##### Private Member Functions ######################################## 00140 00142 // (PLEASE IMPLEMENT IN .cc) 00143 void build_(); 00144 00145 //somes utils 00146 static void softmax_range(Vec &x, Vec &y, int start, int length); 00147 static void logSoftmax_range(Vec &x, Vec &y, int start, int length); 00148 static void hardMax_range(Vec &x, Vec &y, int start, int length, bool value = false); 00149 00150 static void bpropSoftMax(Vec &gradientInput, Vec &gradient, Vec &variableValue, int start, int length); 00151 static void bpropLogSoftMax(Vec &gradientInput, Vec &gradient, Vec &variableValue, int start, int length); 00152 static void bpropHardMaxValue(Vec &gradientInput, Vec &gradient, Vec &variableValue, int start, int length); 00153 00154 00155 private: 00156 //##### Private Data Members ############################################ 00157 00158 // The rest of the private stuff goes here 00159 }; 00160 00161 // Declares a few other classes and functions related to this class 00162 DECLARE_OBJECT_PTR(MultiMaxVariable); 00163 00164 // ### Put here a convenient method for building your variable. 00165 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo 00166 // ### and bar_type bar, you could write: 00167 inline Var MultiMax(Var v, TVec<int> groupsizes, char computation_type) 00168 { return new MultiMaxVariable(v, groupsizes, computation_type); } 00169 00170 } // end of namespace PLearn 00171 00172 #endif 00173 00174 00175 /* 00176 Local Variables: 00177 mode:c++ 00178 c-basic-offset:4 00179 c-file-style:"stroustrup" 00180 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00181 indent-tabs-mode:nil 00182 fill-column:79 00183 End: 00184 */ 00185 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :