PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // SumVarianceOfLinearTransformedCategoricals.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 SumVarianceOfLinearTransformedCategoricals_INC 00041 #define SumVarianceOfLinearTransformedCategoricals_INC 00042 00043 #include <plearn/var/BinaryVariable.h> 00044 00045 namespace PLearn { 00046 using namespace std; 00047 00060 class SumVarianceOfLinearTransformedCategoricals : public BinaryVariable 00061 { 00062 typedef BinaryVariable inherited; 00063 00064 public: 00065 //##### Public Build Options ############################################ 00066 00069 TVec<int> groupsizes; 00070 00071 public: 00072 //##### Public Member Functions ######################################### 00073 00075 SumVarianceOfLinearTransformedCategoricals(); 00076 00078 // ### Make sure the implementation in the .cc calls inherited constructor 00079 // ### and initializes all fields with reasonable default values. 00080 SumVarianceOfLinearTransformedCategoricals(Variable* input1, Variable* input2, bool call_build_ = true); 00081 00082 // ### If your class has parameters, you probably want a constructor that 00083 // ### initializes them 00084 // SumVarianceOfLinearTransformedCategoricals(Variable* input1, Variable* input2, 00085 // param_type the_parameter, ..., bool call_build_ = true); 00086 00087 // Your other public member functions go here 00088 00089 //##### PLearn::Variable methods ######################################### 00090 // (PLEASE IMPLEMENT IN .cc) 00091 virtual void recomputeSize(int& l, int& w) const; 00092 virtual void fprop(); 00093 virtual void bprop(); 00094 00095 // ### These ones are not always implemented 00096 // virtual void bbprop(); 00097 // virtual void symbolicBprop(); 00098 // virtual void rfprop(); 00099 00100 //##### PLearn::Object Protocol ######################################### 00101 00102 // Declares other standard object methods. 00103 // ### If your class is not instantiatable (it has pure virtual methods) 00104 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00105 PLEARN_DECLARE_OBJECT(SumVarianceOfLinearTransformedCategoricals); 00106 00107 // Simply calls inherited::build() then build_() 00108 virtual void build(); 00109 00111 // (PLEASE IMPLEMENT IN .cc) 00112 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00113 00114 protected: 00115 //##### Protected Options ############################################### 00116 00117 // ### Declare protected option fields (such as learned parameters) here 00118 // ... 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 // temporary variables used in fprop and bprop 00138 Vec group_sum_wik_pk; 00139 }; 00140 00141 // Declares a few other classes and functions related to this class 00142 DECLARE_OBJECT_PTR(SumVarianceOfLinearTransformedCategoricals); 00143 00144 // ### Put here a convenient method for building your variable from two 00145 // ### existing ones. 00146 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo 00147 // ### and bar_type bar, you could write: 00148 // inline Var toto(Var v1, Var v2, 00149 // foo_type foo=default_foo, bar_type bar=default_bar) 00150 // { return new TotoVariable(v1, v2, foo, bar); } 00151 00152 } // end of namespace PLearn 00153 00154 #endif 00155 00156 00157 /* 00158 Local Variables: 00159 mode:c++ 00160 c-basic-offset:4 00161 c-file-style:"stroustrup" 00162 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00163 indent-tabs-mode:nil 00164 fill-column:79 00165 End: 00166 */ 00167 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :