PLearn 0.1
TruncatedRealFunction.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // TruncatedRealFunction.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 TruncatedRealFunction_INC
00041 #define TruncatedRealFunction_INC
00042 
00043 #include <plearn/math/RealFunctionOfInputFeature.h>
00044 
00045 namespace PLearn {
00046 
00057 class TruncatedRealFunction : public RealFunctionOfInputFeature
00058 {
00059     typedef RealFunctionOfInputFeature inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00064     real minval;
00065     real maxval;
00066     real val_for_missing;
00067 
00068 public:
00069     //#####  Public Member Functions  #########################################
00070 
00072     TruncatedRealFunction()
00073         : minval(-FLT_MAX),
00074           maxval(FLT_MAX),
00075           val_for_missing(MISSING_VALUE)
00076     {}
00077 
00078     TruncatedRealFunction(int featurenum, 
00079                           real the_minval, real the_maxval,
00080                           real the_val_for_missing)
00081         :inherited(featurenum), 
00082          minval(the_minval),
00083          maxval(the_maxval),
00084          val_for_missing(the_val_for_missing)
00085     {}
00086 
00087     virtual real evaluateFeature(real x) const;
00088 
00089     //#####  PLearn::Object Protocol  #########################################
00090 
00091     // Declares other standard object methods.
00092     PLEARN_DECLARE_OBJECT(TruncatedRealFunction);
00093 
00094     // Simply calls inherited::build() then build_()
00095     virtual void build();
00096 
00098     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00099 
00100 protected:
00101     //#####  Protected Options  ###############################################
00102 
00103     // ### Declare protected option fields (such as learned parameters) here
00104     // ...
00105 
00106 protected:
00107     //#####  Protected Member Functions  ######################################
00108 
00110     static void declareOptions(OptionList& ol);
00111 
00112 private:
00113     //#####  Private Member Functions  ########################################
00114 
00116     void build_();
00117 
00118 private:
00119     //#####  Private Data Members  ############################################
00120 
00121     // The rest of the private stuff goes here
00122 };
00123 
00124 // Declares a few other classes and functions related to this class
00125 DECLARE_OBJECT_PTR(TruncatedRealFunction);
00126 
00127 } // end of namespace PLearn
00128 
00129 #endif
00130 
00131 
00132 /*
00133   Local Variables:
00134   mode:c++
00135   c-basic-offset:4
00136   c-file-style:"stroustrup"
00137   c-file-offsets:((innamespace . 0)(inline-open . 0))
00138   indent-tabs-mode:nil
00139   fill-column:79
00140   End:
00141 */
00142 // 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