| 
    PLearn 0.1 
   | 
 
The first sentence should be a BRIEF DESCRIPTION of what the class does. More...
#include <RealRangeIndicatorFunction.h>


Public Member Functions | |
| RealRangeIndicatorFunction () | |
| Default constructor.   | |
| RealRangeIndicatorFunction (int featurenum, const RealRange &the_range) | |
| virtual real | evaluateFeature (real x) const | 
| This should be implemented in subclasses default verison returns the value of the feature unaltered.   | |
| virtual string | classname () const | 
| virtual OptionList & | getOptionList () const | 
| virtual OptionMap & | getOptionMap () const | 
| virtual RemoteMethodMap & | getRemoteMethodMap () const | 
| virtual  RealRangeIndicatorFunction *  | deepCopy (CopiesMap &copies) const | 
| virtual void | build () | 
| Post-constructor.   | |
| virtual void | makeDeepCopyFromShallowCopy (CopiesMap &copies) | 
| Transforms a shallow copy into a deep copy.   | |
Static Public Member Functions | |
| static string | _classname_ () | 
| static OptionList & | _getOptionList_ () | 
| static RemoteMethodMap & | _getRemoteMethodMap_ () | 
| static Object * | _new_instance_for_typemap_ () | 
| static bool | _isa_ (const Object *o) | 
| static void | _static_initialize_ () | 
| static const PPath & | declaringFile () | 
Public Attributes | |
| RealRange | range | 
Static Public Attributes | |
| static StaticInitializer | _static_initializer_ | 
Static Protected Member Functions | |
| static void | declareOptions (OptionList &ol) | 
| Declares the class options.   | |
Private Types | |
| typedef RealFunctionOfInputFeature | inherited | 
Private Member Functions | |
| void | build_ () | 
| This does the actual building.   | |
The first sentence should be a BRIEF DESCRIPTION of what the class does.
Place the rest of the class programmer documentation here. Doxygen supports Javadoc-style comments. See http://www.doxygen.org/manual.html
Definition at line 59 of file RealRangeIndicatorFunction.h.
typedef RealFunctionOfInputFeature PLearn::RealRangeIndicatorFunction::inherited [private] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 61 of file RealRangeIndicatorFunction.h.
| PLearn::RealRangeIndicatorFunction::RealRangeIndicatorFunction | ( | ) |  [inline] | 
        
| PLearn::RealRangeIndicatorFunction::RealRangeIndicatorFunction | ( | int | featurenum, | 
| const RealRange & | the_range | ||
| ) |  [inline] | 
        
Definition at line 75 of file RealRangeIndicatorFunction.h.
| string PLearn::RealRangeIndicatorFunction::_classname_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
| OptionList & PLearn::RealRangeIndicatorFunction::_getOptionList_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
| RemoteMethodMap & PLearn::RealRangeIndicatorFunction::_getRemoteMethodMap_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
| Object * PLearn::RealRangeIndicatorFunction::_new_instance_for_typemap_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
| StaticInitializer RealRangeIndicatorFunction::_static_initializer_ & PLearn::RealRangeIndicatorFunction::_static_initialize_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
| void PLearn::RealRangeIndicatorFunction::build | ( | ) |  [virtual] | 
        
Post-constructor.
The normal implementation should call simply inherited::build(), then this class's build_(). This method should be callable again at later times, after modifying some option fields to change the "architecture" of the object.
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 52 of file RealRangeIndicatorFunction.cc.
{
    inherited::build();
    build_();
}
| void PLearn::RealRangeIndicatorFunction::build_ | ( | ) |  [private] | 
        
This does the actual building.
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 86 of file RealRangeIndicatorFunction.cc.
{}
| string PLearn::RealRangeIndicatorFunction::classname | ( | ) |  const [virtual] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
| void PLearn::RealRangeIndicatorFunction::declareOptions | ( | OptionList & | ol | ) |  [static, protected] | 
        
Declares the class options.
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 63 of file RealRangeIndicatorFunction.cc.
References PLearn::OptionBase::buildoption, PLearn::declareOption(), and range.
{
    // ### Declare all of this object's options here.
    // ### For the "flags" of each option, you should typically specify
    // ### one of OptionBase::buildoption, OptionBase::learntoption or
    // ### OptionBase::tuningoption. If you don't provide one of these three,
    // ### this option will be ignored when loading values from a script.
    // ### You can also combine flags, for example with OptionBase::nosave:
    // ### (OptionBase::buildoption | OptionBase::nosave)
    declareOption(ol, "range", &RealRangeIndicatorFunction::range,
                  OptionBase::buildoption,
                  "Evaluation will return 1 if x[which_feature] is in range; 0 otherwise.");
    // Now call the parent class' declareOptions
    inherited::declareOptions(ol);
}

| static const PPath& PLearn::RealRangeIndicatorFunction::declaringFile | ( | ) |  [inline, static] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 84 of file RealRangeIndicatorFunction.h.
:
    //#####  Protected Options  ###############################################
| RealRangeIndicatorFunction * PLearn::RealRangeIndicatorFunction::deepCopy | ( | CopiesMap & | copies | ) |  const [virtual] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
This should be implemented in subclasses default verison returns the value of the feature unaltered.
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 81 of file RealRangeIndicatorFunction.cc.
{
    return range.contains(x);
}
| OptionList & PLearn::RealRangeIndicatorFunction::getOptionList | ( | ) |  const [virtual] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
| OptionMap & PLearn::RealRangeIndicatorFunction::getOptionMap | ( | ) |  const [virtual] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
| RemoteMethodMap & PLearn::RealRangeIndicatorFunction::getRemoteMethodMap | ( | ) |  const [virtual] | 
        
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 49 of file RealRangeIndicatorFunction.cc.
| void PLearn::RealRangeIndicatorFunction::makeDeepCopyFromShallowCopy | ( | CopiesMap & | copies | ) |  [virtual] | 
        
Transforms a shallow copy into a deep copy.
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 58 of file RealRangeIndicatorFunction.cc.
{
    inherited::makeDeepCopyFromShallowCopy(copies);
}
Reimplemented from PLearn::RealFunctionOfInputFeature.
Definition at line 84 of file RealRangeIndicatorFunction.h.
Definition at line 66 of file RealRangeIndicatorFunction.h.
Referenced by PLearn::BasisSelectionRegressor::appendCandidateFunctionsOfSingleField(), and declareOptions().
 1.7.4