PLearn 0.1
ShiftAndRescaleFeatureRealFunction.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ShiftAndRescaleFeatureRealFunction.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 "ShiftAndRescaleFeatureRealFunction.h"
00041 
00042 namespace PLearn {
00043 using namespace std;
00044 
00045 PLEARN_IMPLEMENT_OBJECT(
00046     ShiftAndRescaleFeatureRealFunction,
00047     "A function that transforms a feature x yielding (x+shift)*scale",
00048     "Also handles missing values (NaN) by returning value_for_missing."
00049     );
00050 
00051 // ### Nothing to add here, simply calls build_
00052 void ShiftAndRescaleFeatureRealFunction::build()
00053 {
00054     inherited::build();
00055     build_();
00056 }
00057 
00058 void ShiftAndRescaleFeatureRealFunction::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00059 {
00060     inherited::makeDeepCopyFromShallowCopy(copies);
00061 }
00062 
00063 void ShiftAndRescaleFeatureRealFunction::declareOptions(OptionList& ol)
00064 {
00065     // ### Declare all of this object's options here.
00066     // ### For the "flags" of each option, you should typically specify
00067     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00068     // ### OptionBase::tuningoption. If you don't provide one of these three,
00069     // ### this option will be ignored when loading values from a script.
00070     // ### You can also combine flags, for example with OptionBase::nosave:
00071     // ### (OptionBase::buildoption | OptionBase::nosave)
00072 
00073     declareOption(ol, "shift", &ShiftAndRescaleFeatureRealFunction::shift,
00074                   OptionBase::buildoption,
00075                   "Evaluation will return (x[which_feature]+shift)*scale.");
00076 
00077     declareOption(ol, "scale", &ShiftAndRescaleFeatureRealFunction::scale,
00078                   OptionBase::buildoption,
00079                   "Evaluation will return (x[which_feature]+shift)*scale.");
00080 
00081     declareOption(ol, "value_for_missing", &ShiftAndRescaleFeatureRealFunction::value_for_missing,
00082                   OptionBase::buildoption,
00083                   "If x[which_feature] is missing (NaN), evaluation will return value_for_missing.");
00084 
00085     // Now call the parent class' declareOptions
00086     inherited::declareOptions(ol);
00087 }
00088 
00089 real ShiftAndRescaleFeatureRealFunction::evaluateFeature(real x) const
00090 {
00091     if(is_missing(x))
00092         return value_for_missing;
00093     else
00094         return (x+shift)*scale;
00095 }
00096 
00097 void ShiftAndRescaleFeatureRealFunction::build_()
00098 {}
00099 
00100 
00101 } // end of namespace PLearn
00102 
00103 
00104 /*
00105   Local Variables:
00106   mode:c++
00107   c-basic-offset:4
00108   c-file-style:"stroustrup"
00109   c-file-offsets:((innamespace . 0)(inline-open . 0))
00110   indent-tabs-mode:nil
00111   fill-column:79
00112   End:
00113 */
00114 // 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