PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // DoubleProductVariable.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 DoubleProductVariable_INC 00041 #define DoubleProductVariable_INC 00042 00043 #include <plearn/var/NaryVariable.h> 00044 00045 namespace PLearn { 00046 using namespace std; 00047 00060 class DoubleProductVariable : public NaryVariable 00061 { 00062 typedef NaryVariable inherited; 00063 00064 public: 00065 //##### Public Build Options ############################################ 00066 00069 00070 public: 00071 //##### Public Member Functions ######################################### 00072 00074 DoubleProductVariable() {} 00075 00077 DoubleProductVariable(Var& input1, Var& input2, Var& input3); 00078 00079 // For clear and easy access 00080 Var& varX() { return varray[0]; } 00081 Var& varW() { return varray[1]; } 00082 Var& varM() { return varray[2]; } 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(DoubleProductVariable); 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 protected: 00118 //##### Protected Member Functions ###################################### 00119 00121 // (PLEASE IMPLEMENT IN .cc) 00122 static void declareOptions(OptionList& ol); 00123 00124 private: 00125 //##### Private Member Functions ######################################## 00126 00128 // (PLEASE IMPLEMENT IN .cc) 00129 void build_(); 00130 00131 private: 00132 //##### Private Data Members ############################################ 00133 00134 // The rest of the private stuff goes here 00135 }; 00136 00137 // Declares a few other classes and functions related to this class 00138 DECLARE_OBJECT_PTR(DoubleProductVariable); 00139 00140 // ### Put here a convenient method for building your variable from other 00141 // ### existing ones, or a VarArray. 00142 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo 00143 // ### and bar_type bar, you could write, depending on your constructor: 00144 // inline Var toto(Var v1, Var v2, Var v3, 00145 // foo_type foo=default_foo, bar_type bar=default_bar) 00146 // { return new TotoVariable(v1, v2, v3, foo, bar); } 00147 // ### or: 00148 // inline Var toto(Var v1, Var v2, v3 00149 // foo_type foo=default_foo, bar_type bar=default_bar) 00150 // { return new TotoVariable(v1 & v2 & v3, foo, bar); } 00151 // ### or: 00152 // inline Var toto(const VarArray& varray, foo_type foo=default_foo, 00153 // bar_type bar=default_bar) 00154 // { return new TotoVariable( varray, foo, bar); } 00155 00156 } // end of namespace PLearn 00157 00158 #endif 00159 00160 00161 /* 00162 Local Variables: 00163 mode:c++ 00164 c-basic-offset:4 00165 c-file-style:"stroustrup" 00166 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00167 indent-tabs-mode:nil 00168 fill-column:79 00169 End: 00170 */ 00171 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :