PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // ConstantRealFunction.cc 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 #include "ConstantRealFunction.h" 00041 00042 namespace PLearn { 00043 using namespace std; 00044 00045 PLEARN_IMPLEMENT_OBJECT( 00046 ConstantRealFunction, 00047 "A Function Vec->real that always returns the same constant", 00048 "" 00049 ); 00050 00051 // ### Nothing to add here, simply calls build_ 00052 void ConstantRealFunction::build() 00053 { 00054 inherited::build(); 00055 build_(); 00056 } 00057 00058 void ConstantRealFunction::makeDeepCopyFromShallowCopy(CopiesMap& copies) 00059 { 00060 inherited::makeDeepCopyFromShallowCopy(copies); 00061 } 00062 00063 void ConstantRealFunction::declareOptions(OptionList& ol) 00064 { 00065 declareOption(ol, "constantval", &ConstantRealFunction::constantval, 00066 OptionBase::buildoption, 00067 "The constant real returned by evaluate"); 00068 00069 // Now call the parent class' declareOptions 00070 inherited::declareOptions(ol); 00071 } 00072 00073 real ConstantRealFunction::evaluate(const Vec& x) const 00074 { 00075 return constantval; 00076 } 00077 00078 00079 void ConstantRealFunction::build_() 00080 { 00081 // ### This method should do the real building of the object, 00082 // ### according to set 'options', in *any* situation. 00083 // ### Typical situations include: 00084 // ### - Initial building of an object from a few user-specified options 00085 // ### - Building of a "reloaded" object: i.e. from the complete set of 00086 // ### all serialised options. 00087 // ### - Updating or "re-building" of an object after a few "tuning" 00088 // ### options have been modified. 00089 // ### You should assume that the parent class' build_() has already been 00090 // ### called. 00091 } 00092 00093 00094 } // end of namespace PLearn 00095 00096 00097 /* 00098 Local Variables: 00099 mode:c++ 00100 c-basic-offset:4 00101 c-file-style:"stroustrup" 00102 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00103 indent-tabs-mode:nil 00104 fill-column:79 00105 End: 00106 */ 00107 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :