PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // ConstrainedSourceVariable.h 00004 // 00005 // Copyright (C) 2008 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: Pascal Vincent 00036 00040 #ifndef ConstrainedSourceVariable_INC 00041 #define ConstrainedSourceVariable_INC 00042 00043 #include <plearn/var/SourceVariable.h> 00044 00045 namespace PLearn { 00046 using namespace std; 00047 00054 class ConstrainedSourceVariable : public SourceVariable 00055 { 00056 typedef SourceVariable inherited; 00057 00058 public: 00059 //##### Public Build Options ############################################ 00060 00061 int constraint_mode; 00062 00063 public: 00065 ConstrainedSourceVariable() 00066 :SourceVariable(), 00067 constraint_mode(2) 00068 {} 00069 00070 ConstrainedSourceVariable(int thelength, int thewidth, int the_constraint_mode=2, bool call_build_ = true) 00071 :SourceVariable(thelength, thewidth, call_build_), 00072 constraint_mode(the_constraint_mode) 00073 {} 00074 00075 ConstrainedSourceVariable(const Vec& v, bool vertical=true, int the_constraint_mode=2, bool call_build_ = true) 00076 :SourceVariable(v, vertical, call_build_), 00077 constraint_mode(the_constraint_mode) 00078 {} 00079 00080 ConstrainedSourceVariable(const Mat& m, int the_constraint_mode=2, bool call_build_ = true) 00081 :SourceVariable(m, call_build_), 00082 constraint_mode(the_constraint_mode) 00083 {} 00084 00085 // The method that will be called after each update to satisfy the constraints. 00086 virtual void satisfyConstraints(); 00087 00088 //##### PLearn::Object Protocol ######################################### 00089 00090 // Declares other standard object methods. 00091 PLEARN_DECLARE_OBJECT(ConstrainedSourceVariable); 00092 00093 // Simply calls inherited::build() then build_() 00094 virtual void build(); 00095 00097 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00098 00099 00100 //##### 'Variable' Interface ############################################ 00101 00102 00103 // All the 'update' methods are overridden to be followed by a call to satisfyConstraints(), 00104 // whose purpose is to "correct" the values after an update so that they fulfill the constraints 00105 virtual bool update(real step_size, Vec direction_vec, real coeff = 1.0, real b = 0.0); 00106 virtual bool update(Vec step_sizes, Vec direction_vec, real coeff = 1.0, real b = 0.0); 00107 virtual bool update(real step_size, bool clear=false); 00108 virtual bool update(Vec new_value); 00109 virtual void updateAndClear(); 00110 virtual void updateWithWeightDecay(real step_size, real weight_decay, 00111 bool L1, bool clear=true); 00112 00113 00114 protected: 00116 static void declareOptions(OptionList& ol); 00117 00118 private: 00120 void build_(); 00121 }; 00122 00123 00124 DECLARE_OBJECT_PTR(ConstrainedSourceVariable); 00125 00126 } // end of namespace PLearn 00127 00128 #endif 00129 00130 00131 /* 00132 Local Variables: 00133 mode:c++ 00134 c-basic-offset:4 00135 c-file-style:"stroustrup" 00136 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00137 indent-tabs-mode:nil 00138 fill-column:79 00139 End: 00140 */ 00141 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :