PLearn 0.1
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Static Protected Member Functions | Private Types | Private Member Functions
PLearn::TruncatedRealFunction Class Reference

The first sentence should be a BRIEF DESCRIPTION of what the class does. More...

#include <TruncatedRealFunction.h>

Inheritance diagram for PLearn::TruncatedRealFunction:
Inheritance graph
[legend]
Collaboration diagram for PLearn::TruncatedRealFunction:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 TruncatedRealFunction ()
 Default constructor.
 TruncatedRealFunction (int featurenum, real the_minval, real the_maxval, real the_val_for_missing)
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 OptionListgetOptionList () const
virtual OptionMapgetOptionMap () const
virtual RemoteMethodMapgetRemoteMethodMap () const
virtual TruncatedRealFunctiondeepCopy (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 PPathdeclaringFile ()

Public Attributes

real minval
real maxval
real val_for_missing

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.

Detailed Description

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

Todo:
Write class to-do's here if there are any.
Deprecated:
Write deprecated stuff here if there is any. Indicate what else should be used instead.

Definition at line 57 of file TruncatedRealFunction.h.


Member Typedef Documentation

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 59 of file TruncatedRealFunction.h.


Constructor & Destructor Documentation

PLearn::TruncatedRealFunction::TruncatedRealFunction ( ) [inline]

Default constructor.

Definition at line 72 of file TruncatedRealFunction.h.

        : minval(-FLT_MAX),
          maxval(FLT_MAX),
          val_for_missing(MISSING_VALUE)
    {}
PLearn::TruncatedRealFunction::TruncatedRealFunction ( int  featurenum,
real  the_minval,
real  the_maxval,
real  the_val_for_missing 
) [inline]

Definition at line 78 of file TruncatedRealFunction.h.

        :inherited(featurenum), 
         minval(the_minval),
         maxval(the_maxval),
         val_for_missing(the_val_for_missing)
    {}

Member Function Documentation

string PLearn::TruncatedRealFunction::_classname_ ( ) [static]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

OptionList & PLearn::TruncatedRealFunction::_getOptionList_ ( ) [static]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

RemoteMethodMap & PLearn::TruncatedRealFunction::_getRemoteMethodMap_ ( ) [static]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

bool PLearn::TruncatedRealFunction::_isa_ ( const Object o) [static]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

Object * PLearn::TruncatedRealFunction::_new_instance_for_typemap_ ( ) [static]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

StaticInitializer TruncatedRealFunction::_static_initializer_ & PLearn::TruncatedRealFunction::_static_initialize_ ( ) [static]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

void PLearn::TruncatedRealFunction::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 TruncatedRealFunction.cc.

void PLearn::TruncatedRealFunction::build_ ( ) [private]

This does the actual building.

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 100 of file TruncatedRealFunction.cc.

{}
string PLearn::TruncatedRealFunction::classname ( ) const [virtual]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

void PLearn::TruncatedRealFunction::declareOptions ( OptionList ol) [static, protected]

Declares the class options.

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 63 of file TruncatedRealFunction.cc.

References PLearn::OptionBase::buildoption, PLearn::declareOption(), maxval, and minval.

{
    // ### 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, "minval", &TruncatedRealFunction::minval,
                  OptionBase::buildoption,
                  "If x[which_feature]<=minval, minval is returned.");

    declareOption(ol, "maxval", &TruncatedRealFunction::maxval,
                  OptionBase::buildoption,
                  "If x[which_feature]>=maxval, maxval is returned.");

    declareOption(ol, "val_for_missing", &TruncatedRealFunction::maxval,
                  OptionBase::buildoption,
                  "Value to be returned if x[which_feature] is missing (NaN).");

    // Now call the parent class' declareOptions
    inherited::declareOptions(ol);
}

Here is the call graph for this function:

static const PPath& PLearn::TruncatedRealFunction::declaringFile ( ) [inline, static]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 92 of file TruncatedRealFunction.h.

:
    //#####  Protected Options  ###############################################
TruncatedRealFunction * PLearn::TruncatedRealFunction::deepCopy ( CopiesMap copies) const [virtual]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

real PLearn::TruncatedRealFunction::evaluateFeature ( real  x) const [virtual]

This should be implemented in subclasses default verison returns the value of the feature unaltered.

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 89 of file TruncatedRealFunction.cc.

References PLearn::is_missing(), and x.

{
    if(is_missing(x))
        return val_for_missing;
    else if(x<=minval)
        return minval;
    else if(x>=maxval)
        return maxval;
    return x;
}

Here is the call graph for this function:

OptionList & PLearn::TruncatedRealFunction::getOptionList ( ) const [virtual]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

OptionMap & PLearn::TruncatedRealFunction::getOptionMap ( ) const [virtual]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

RemoteMethodMap & PLearn::TruncatedRealFunction::getRemoteMethodMap ( ) const [virtual]

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 49 of file TruncatedRealFunction.cc.

void PLearn::TruncatedRealFunction::makeDeepCopyFromShallowCopy ( CopiesMap copies) [virtual]

Transforms a shallow copy into a deep copy.

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 58 of file TruncatedRealFunction.cc.


Member Data Documentation

Reimplemented from PLearn::RealFunctionOfInputFeature.

Definition at line 92 of file TruncatedRealFunction.h.

Definition at line 65 of file TruncatedRealFunction.h.

Referenced by declareOptions().

Definition at line 64 of file TruncatedRealFunction.h.

Referenced by declareOptions().

Definition at line 66 of file TruncatedRealFunction.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines