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