PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // RealFunction.h 00004 // 00005 // Copyright (C) 2006 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 RealFunction_INC 00041 #define RealFunction_INC 00042 00043 #include <plearn/base/Object.h> 00044 00045 namespace PLearn { 00046 00057 class RealFunction : public Object 00058 { 00059 typedef Object inherited; 00060 00061 public: 00062 //##### Public Build Options ############################################ 00063 00066 00068 string info; 00069 00070 public: 00071 //##### Public Member Functions ######################################### 00072 00073 RealFunction() {} 00074 00075 // Your other public member functions go here 00076 virtual real evaluate(const Vec& x) const = 0; 00077 00078 inline real operator()(const Vec& x) const 00079 { return evaluate(x); } 00080 00081 void setInfo(const string& infostr) 00082 { info = infostr; } 00083 00084 string getInfo() const 00085 { return info; } 00086 00087 00088 //##### PLearn::Object Protocol ######################################### 00089 00090 // Declares other standard object methods. 00091 // ### If your class is not instantiatable (it has pure virtual methods) 00092 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00093 PLEARN_DECLARE_ABSTRACT_OBJECT(RealFunction); 00094 00095 // Simply calls inherited::build() then build_() 00096 virtual void build(); 00097 00099 // (PLEASE IMPLEMENT IN .cc) 00100 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00101 00102 protected: 00103 //##### Protected Options ############################################### 00104 00105 // ### Declare protected option fields (such as learned parameters) here 00106 // ... 00107 00108 protected: 00109 //##### Protected Member Functions ###################################### 00110 00112 // (PLEASE IMPLEMENT IN .cc) 00113 static void declareOptions(OptionList& ol); 00114 00115 private: 00116 //##### Private Member Functions ######################################## 00117 00119 // (PLEASE IMPLEMENT IN .cc) 00120 void build_(); 00121 00122 private: 00123 //##### Private Data Members ############################################ 00124 00125 // The rest of the private stuff goes here 00126 }; 00127 00128 // Declares a few other classes and functions related to this class 00129 DECLARE_OBJECT_PTR(RealFunction); 00130 00131 typedef PP<RealFunction> RealFunc; 00132 00134 void evaluate_functions(const TVec<RealFunc>& functions, const Vec& input, 00135 Vec& featurevec); 00136 00137 00138 } // end of namespace PLearn 00139 00140 #endif 00141 00142 00143 /* 00144 Local Variables: 00145 mode:c++ 00146 c-basic-offset:4 00147 c-file-style:"stroustrup" 00148 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00149 indent-tabs-mode:nil 00150 fill-column:79 00151 End: 00152 */ 00153 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :