PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // LinearCombinationOfScalarVariables.h 00004 // 00005 // Copyright (C) 2009 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 LinearCombinationOfScalarVariables_INC 00041 #define LinearCombinationOfScalarVariables_INC 00042 00043 #include <plearn/var/NaryVariable.h> 00044 00045 namespace PLearn { 00046 using namespace std; 00047 00060 class LinearCombinationOfScalarVariables : public NaryVariable 00061 { 00062 typedef NaryVariable inherited; 00063 00064 public: 00065 //##### Public Build Options ############################################ 00066 00069 00071 Vec coefs; 00072 real constant_term; 00073 bool appendinputs; 00074 00075 public: 00076 //##### Public Member Functions ######################################### 00077 00079 LinearCombinationOfScalarVariables(); 00080 00082 // NaryVariable constructor (inherited) takes a VarArray as 00083 // argument. You can either construct from a VarArray (if the 00084 // number of parent Var is not fixed, for instance), or construct 00085 // a VarArray from Var by operator &: input1 & input2 & 00086 // input3. You can also do both, uncomment what you prefer. 00087 00088 // ### Make sure the implementation in the .cc calls inherited constructor 00089 // ### and initializes all fields with reasonable default values. 00090 // LinearCombinationOfScalarVariables(const VarArray& vararray); 00091 // LinearCombinationOfScalarVariables(Var input1, Var input2, Var input3, ...); 00092 00093 // ### If your class has parameters, you probably want a constructor that 00094 // ### initializes them 00095 LinearCombinationOfScalarVariables(const VarArray& vararray, Vec the_coefs); 00096 00097 // ### If your parent variables are a meaning and you want to be able to 00098 // ### access them easily, you can add functions like: 00099 // Var& First() { return varray[0]; } 00100 // Var& Second() { return varray[1]; } 00101 // ... 00102 00103 // Your other public member functions go here 00104 00105 //##### PLearn::Variable methods ######################################### 00106 // (PLEASE IMPLEMENT IN .cc) 00107 virtual void recomputeSize(int& l, int& w) const; 00108 virtual void fprop(); 00109 virtual void bprop(); 00110 00111 // ### These ones are not always implemented 00112 // virtual void bbprop(); 00113 // virtual void symbolicBprop(); 00114 // virtual void rfprop(); 00115 00116 //##### PLearn::Object Protocol ######################################### 00117 00118 // Declares other standard object methods. 00119 // ### If your class is not instantiatable (it has pure virtual methods) 00120 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00121 PLEARN_DECLARE_OBJECT(LinearCombinationOfScalarVariables); 00122 00123 // Simply calls inherited::build() then build_() 00124 virtual void build(); 00125 00127 // (PLEASE IMPLEMENT IN .cc) 00128 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00129 00130 protected: 00131 //##### Protected Options ############################################### 00132 00133 // ### Declare protected option fields (such as learned parameters) here 00134 // ... 00135 00136 protected: 00137 //##### Protected Member Functions ###################################### 00138 00140 // (PLEASE IMPLEMENT IN .cc) 00141 static void declareOptions(OptionList& ol); 00142 00143 private: 00144 //##### Private Member Functions ######################################## 00145 00147 // (PLEASE IMPLEMENT IN .cc) 00148 void build_(); 00149 00150 private: 00151 //##### Private Data Members ############################################ 00152 00153 // The rest of the private stuff goes here 00154 }; 00155 00156 // Declares a few other classes and functions related to this class 00157 DECLARE_OBJECT_PTR(LinearCombinationOfScalarVariables); 00158 00159 // ### Put here a convenient method for building your variable from other 00160 // ### existing ones, or a VarArray. 00161 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo 00162 // ### and bar_type bar, you could write, depending on your constructor: 00163 // inline Var toto(Var v1, Var v2, Var v3, 00164 // foo_type foo=default_foo, bar_type bar=default_bar) 00165 // { return new TotoVariable(v1, v2, v3, foo, bar); } 00166 // ### or: 00167 // inline Var toto(Var v1, Var v2, v3 00168 // foo_type foo=default_foo, bar_type bar=default_bar) 00169 // { return new TotoVariable(v1 & v2 & v3, foo, bar); } 00170 // ### or: 00171 // inline Var toto(const VarArray& varray, foo_type foo=default_foo, 00172 // bar_type bar=default_bar) 00173 // { return new TotoVariable( varray, foo, bar); } 00174 00175 } // end of namespace PLearn 00176 00177 #endif 00178 00179 00180 /* 00181 Local Variables: 00182 mode:c++ 00183 c-basic-offset:4 00184 c-file-style:"stroustrup" 00185 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00186 indent-tabs-mode:nil 00187 fill-column:79 00188 End: 00189 */ 00190 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :