PLearn 0.1
ShiftAndRescaleFeatureRealFunction.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ShiftAndRescaleFeatureRealFunction.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 ShiftAndRescaleFeatureRealFunction_INC
00041 #define ShiftAndRescaleFeatureRealFunction_INC
00042 
00043 #include <plearn/math/RealFunctionOfInputFeature.h>
00044 
00045 namespace PLearn {
00046 
00057 class ShiftAndRescaleFeatureRealFunction : public RealFunctionOfInputFeature
00058 {
00059     typedef RealFunctionOfInputFeature inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00064     real shift;
00065     real scale;
00066     real value_for_missing;
00067     
00068 public:
00069     //#####  Public Member Functions  #########################################
00070 
00071     ShiftAndRescaleFeatureRealFunction(int featurenum=-1, 
00072                                        real the_shift=0, 
00073                                        real the_scale=1,
00074                                        real the_value_for_missing=MISSING_VALUE)
00075         :inherited(featurenum), 
00076          shift(the_shift),
00077          scale(the_scale),
00078          value_for_missing(the_value_for_missing)
00079     {}
00080 
00081     virtual real evaluateFeature(real x) const;
00082 
00083     //#####  PLearn::Object Protocol  #########################################
00084 
00085     // Declares other standard object methods.
00086     PLEARN_DECLARE_OBJECT(ShiftAndRescaleFeatureRealFunction);
00087 
00088     // Simply calls inherited::build() then build_()
00089     virtual void build();
00090 
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     static void declareOptions(OptionList& ol);
00105 
00106 private:
00107     //#####  Private Member Functions  ########################################
00108 
00110     void build_();
00111 
00112 private:
00113     //#####  Private Data Members  ############################################
00114 
00115     // The rest of the private stuff goes here
00116 };
00117 
00118 // Declares a few other classes and functions related to this class
00119 DECLARE_OBJECT_PTR(ShiftAndRescaleFeatureRealFunction);
00120 
00121 } // end of namespace PLearn
00122 
00123 #endif
00124 
00125 
00126 /*
00127   Local Variables:
00128   mode:c++
00129   c-basic-offset:4
00130   c-file-style:"stroustrup"
00131   c-file-offsets:((innamespace . 0)(inline-open . 0))
00132   indent-tabs-mode:nil
00133   fill-column:79
00134   End:
00135 */
00136 // 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