PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // RandomForcedValuesVariable.h 00004 // 00005 // Copyright (C) 2007 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 RandomForcedValuesVariable_INC 00041 #define RandomForcedValuesVariable_INC 00042 00043 #include <plearn/var/UnaryVariable.h> 00044 #include <plearn/math/PRandom.h> 00045 00046 namespace PLearn { 00047 using namespace std; 00048 00061 class RandomForcedValuesVariable : public UnaryVariable 00062 { 00063 typedef UnaryVariable inherited; 00064 00065 public: 00066 //##### Public Build Options ############################################ 00067 00070 PP<PRandom> random_gen; 00071 real forcing_prob; 00072 real forcing_value; 00073 00074 public: 00075 //##### Public Member Functions ######################################### 00076 00078 RandomForcedValuesVariable(); 00079 00080 // ### If your class has parameters, you probably want a constructor that 00081 // ### initializes them 00082 // RandomForcedValuesVariable(Variable* input, param_type the_parameter, ...); 00083 00084 // Your other public member functions go here 00085 00086 //##### PLearn::Variable methods ######################################### 00087 // (PLEASE IMPLEMENT IN .cc) 00088 virtual void recomputeSize(int& l, int& w) const; 00089 virtual void fprop(); 00090 virtual void bprop(); 00091 00092 // ### These ones are not always implemented 00093 // virtual void bbprop(); 00094 // virtual void symbolicBprop(); 00095 // virtual void rfprop(); 00096 00097 //##### PLearn::Object Protocol ######################################### 00098 00099 // Declares other standard object methods. 00100 // ### If your class is not instantiatable (it has pure virtual methods) 00101 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00102 PLEARN_DECLARE_OBJECT(RandomForcedValuesVariable); 00103 00104 // Simply calls inherited::build() then build_() 00105 virtual void build(); 00106 00108 // (PLEASE IMPLEMENT IN .cc) 00109 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00110 00111 protected: 00112 //##### Protected Options ############################################### 00113 00114 // ### Declare protected option fields (such as learned parameters) here 00115 // ... 00116 00117 // will contain true where features have been forced to forcing_value 00118 TVec<bool> forced; 00119 00120 protected: 00121 //##### Protected Member Functions ###################################### 00122 00124 // (PLEASE IMPLEMENT IN .cc) 00125 static void declareOptions(OptionList& ol); 00126 00127 private: 00128 //##### Private Member Functions ######################################## 00129 00131 // (PLEASE IMPLEMENT IN .cc) 00132 void build_(); 00133 00134 private: 00135 //##### Private Data Members ############################################ 00136 00137 // The rest of the private stuff goes here 00138 }; 00139 00140 // Declares a few other classes and functions related to this class 00141 DECLARE_OBJECT_PTR(RandomForcedValuesVariable); 00142 00143 // ### Put here a convenient method for building your variable. 00144 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo 00145 // ### and bar_type bar, you could write: 00146 // inline Var toto(Var v, foo_type foo=default_foo, bar_type bar=default_bar) 00147 // { return new TotoVariable(v, foo, bar); } 00148 00149 } // end of namespace PLearn 00150 00151 #endif 00152 00153 00154 /* 00155 Local Variables: 00156 mode:c++ 00157 c-basic-offset:4 00158 c-file-style:"stroustrup" 00159 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00160 indent-tabs-mode:nil 00161 fill-column:79 00162 End: 00163 */ 00164 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :