PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // ConstantRealFunction.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 ConstantRealFunction_INC 00041 #define ConstantRealFunction_INC 00042 00043 #include <plearn/math/RealFunction.h> 00044 00045 namespace PLearn { 00046 00057 class ConstantRealFunction : public RealFunction 00058 { 00059 typedef RealFunction inherited; 00060 00061 public: 00062 //##### Public Build Options ############################################ 00063 00065 real constantval; 00066 00067 public: 00068 //##### Public Member Functions ######################################### 00069 00071 // ### Make sure the implementation in the .cc 00072 // ### initializes all fields to reasonable default values. 00073 ConstantRealFunction() 00074 :constantval(1.0) 00075 {} 00076 00077 virtual real evaluate(const Vec& x) const; 00078 00079 inline real operator()(const Vec& x) const 00080 { return evaluate(x); } 00081 00082 //##### PLearn::Object Protocol ######################################### 00083 00084 // Declares other standard object methods. 00085 PLEARN_DECLARE_OBJECT(ConstantRealFunction); 00086 00087 // Simply calls inherited::build() then build_() 00088 virtual void build(); 00089 00091 // (PLEASE IMPLEMENT IN .cc) 00092 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00093 00094 protected: 00095 //##### Protected Options ############################################### 00096 00097 // ### Declare protected option fields (such as learned parameters) here 00098 // ... 00099 00100 protected: 00101 //##### Protected Member Functions ###################################### 00102 00104 // (PLEASE IMPLEMENT IN .cc) 00105 static void declareOptions(OptionList& ol); 00106 00107 private: 00108 //##### Private Member Functions ######################################## 00109 00111 // (PLEASE IMPLEMENT IN .cc) 00112 void build_(); 00113 00114 private: 00115 //##### Private Data Members ############################################ 00116 00117 // The rest of the private stuff goes here 00118 }; 00119 00120 // Declares a few other classes and functions related to this class 00121 DECLARE_OBJECT_PTR(ConstantRealFunction); 00122 00123 } // end of namespace PLearn 00124 00125 #endif 00126 00127 00128 /* 00129 Local Variables: 00130 mode:c++ 00131 c-basic-offset:4 00132 c-file-style:"stroustrup" 00133 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00134 indent-tabs-mode:nil 00135 fill-column:79 00136 End: 00137 */ 00138 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :