PLearn 0.1
RealValueIndicatorFunction.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RealValueIndicatorFunction.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 "RealValueIndicatorFunction.h"
00041 #include <plearn/math/pl_math.h>
00042 
00043 namespace PLearn {
00044 using namespace std;
00045 
00046 PLEARN_IMPLEMENT_OBJECT(
00047     RealValueIndicatorFunction,
00048     "An indicator function, yielding whether a given input feature equals a given value",
00049     ""
00050     );
00051 
00052 // ### Nothing to add here, simply calls build_
00053 void RealValueIndicatorFunction::build()
00054 {
00055     inherited::build();
00056     build_();
00057 }
00058 
00059 void RealValueIndicatorFunction::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00060 {
00061     inherited::makeDeepCopyFromShallowCopy(copies);
00062 }
00063 
00064 void RealValueIndicatorFunction::declareOptions(OptionList& ol)
00065 {
00066     // ### Declare all of this object's options here.
00067     // ### For the "flags" of each option, you should typically specify
00068     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00069     // ### OptionBase::tuningoption. If you don't provide one of these three,
00070     // ### this option will be ignored when loading values from a script.
00071     // ### You can also combine flags, for example with OptionBase::nosave:
00072     // ### (OptionBase::buildoption | OptionBase::nosave)
00073 
00074     declareOption(ol, "value", &RealValueIndicatorFunction::value,
00075                   OptionBase::buildoption,
00076                   "Evaluation will return 1 if x[which_feature] equals value; 0 otherwise.\n"
00077                   "Comparison uses is_equal function which handles 'nan' and 'inf' correctly,\n"
00078                   "and also has a small tolerance for float values.\n");
00079 
00080     // Now call the parent class' declareOptions
00081     inherited::declareOptions(ol);
00082 }
00083 
00084 real RealValueIndicatorFunction::evaluateFeature(real x) const
00085 {
00086     return is_equal(x,value);
00087 }
00088 
00089 void RealValueIndicatorFunction::build_()
00090 {}
00091 
00092 
00093 } // end of namespace PLearn
00094 
00095 
00096 /*
00097   Local Variables:
00098   mode:c++
00099   c-basic-offset:4
00100   c-file-style:"stroustrup"
00101   c-file-offsets:((innamespace . 0)(inline-open . 0))
00102   indent-tabs-mode:nil
00103   fill-column:79
00104   End:
00105 */
00106 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines