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