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::RealFunctionOfInputFeature Class Reference

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

#include <RealFunctionOfInputFeature.h>

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

List of all members.

Public Member Functions

 RealFunctionOfInputFeature ()
 Default constructor.
 RealFunctionOfInputFeature (int featurenum)
virtual real evaluate (const Vec &x) const
 This simply calls evaluateFeature(x[which_feature])
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
RealFunctionOfInputFeature
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 PPathdeclaringFile ()

Public Attributes

int which_feature

Static Public Attributes

static StaticInitializer _static_initializer_

Static Protected Member Functions

static void declareOptions (OptionList &ol)
 Declares the class options.

Private Types

typedef RealFunction 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 RealFunctionOfInputFeature.h.


Member Typedef Documentation


Constructor & Destructor Documentation

PLearn::RealFunctionOfInputFeature::RealFunctionOfInputFeature ( ) [inline]

Default constructor.

Definition at line 70 of file RealFunctionOfInputFeature.h.

    :which_feature(0) 
    {}
PLearn::RealFunctionOfInputFeature::RealFunctionOfInputFeature ( int  featurenum) [inline]

Definition at line 74 of file RealFunctionOfInputFeature.h.

        :which_feature(featurenum)
    {}

Member Function Documentation

string PLearn::RealFunctionOfInputFeature::_classname_ ( ) [static]
OptionList & PLearn::RealFunctionOfInputFeature::_getOptionList_ ( ) [static]
RemoteMethodMap & PLearn::RealFunctionOfInputFeature::_getRemoteMethodMap_ ( ) [static]
bool PLearn::RealFunctionOfInputFeature::_isa_ ( const Object o) [static]
Object * PLearn::RealFunctionOfInputFeature::_new_instance_for_typemap_ ( ) [static]
StaticInitializer RealFunctionOfInputFeature::_static_initializer_ & PLearn::RealFunctionOfInputFeature::_static_initialize_ ( ) [static]
void PLearn::RealFunctionOfInputFeature::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::RealFunction.

Reimplemented in PLearn::RealRangeIndicatorFunction, PLearn::RealValueIndicatorFunction, PLearn::ShiftAndRescaleFeatureRealFunction, and PLearn::TruncatedRealFunction.

Definition at line 53 of file RealFunctionOfInputFeature.cc.

void PLearn::RealFunctionOfInputFeature::build_ ( ) [private]
string PLearn::RealFunctionOfInputFeature::classname ( ) const [virtual]
void PLearn::RealFunctionOfInputFeature::declareOptions ( OptionList ol) [static, protected]

Declares the class options.

Reimplemented from PLearn::RealFunction.

Reimplemented in PLearn::RealRangeIndicatorFunction, PLearn::RealValueIndicatorFunction, PLearn::ShiftAndRescaleFeatureRealFunction, and PLearn::TruncatedRealFunction.

Definition at line 64 of file RealFunctionOfInputFeature.cc.

References PLearn::OptionBase::buildoption, PLearn::declareOption(), and which_feature.

{
    // ### 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, "which_feature", &RealFunctionOfInputFeature::which_feature,
                  OptionBase::buildoption,
                  "Index of the input feature considered");

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

Here is the call graph for this function:

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

Reimplemented from PLearn::RealFunction.

Reimplemented in PLearn::RealRangeIndicatorFunction, PLearn::RealValueIndicatorFunction, PLearn::ShiftAndRescaleFeatureRealFunction, and PLearn::TruncatedRealFunction.

Definition at line 88 of file RealFunctionOfInputFeature.h.

:
    //#####  Protected Options  ###############################################
RealFunctionOfInputFeature * PLearn::RealFunctionOfInputFeature::deepCopy ( CopiesMap copies) const [virtual]
real PLearn::RealFunctionOfInputFeature::evaluate ( const Vec x) const [virtual]

This simply calls evaluateFeature(x[which_feature])

Implements PLearn::RealFunction.

Definition at line 82 of file RealFunctionOfInputFeature.cc.

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

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

Reimplemented in PLearn::RealRangeIndicatorFunction, PLearn::RealValueIndicatorFunction, PLearn::ShiftAndRescaleFeatureRealFunction, and PLearn::TruncatedRealFunction.

Definition at line 87 of file RealFunctionOfInputFeature.cc.

References x.

{ return x; }
OptionList & PLearn::RealFunctionOfInputFeature::getOptionList ( ) const [virtual]
OptionMap & PLearn::RealFunctionOfInputFeature::getOptionMap ( ) const [virtual]
RemoteMethodMap & PLearn::RealFunctionOfInputFeature::getRemoteMethodMap ( ) const [virtual]
void PLearn::RealFunctionOfInputFeature::makeDeepCopyFromShallowCopy ( CopiesMap copies) [virtual]

Member Data Documentation

Definition at line 64 of file RealFunctionOfInputFeature.h.

Referenced by declareOptions().


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