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

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

#include <RealFunction.h>

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

List of all members.

Public Member Functions

 RealFunction ()
virtual real evaluate (const Vec &x) const =0
real operator() (const Vec &x) const
void setInfo (const string &infostr)
string getInfo () const
virtual RealFunctiondeepCopy (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 bool _isa_ (const Object *o)
static void _static_initialize_ ()
static const PPathdeclaringFile ()

Public Attributes

string info
 ### declare public option fields (such as build options) here Start your comments with Doxygen-compatible comments such as //!

Static Public Attributes

static StaticInitializer _static_initializer_

Static Protected Member Functions

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

Private Types

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


Member Typedef Documentation


Constructor & Destructor Documentation

PLearn::RealFunction::RealFunction ( ) [inline]

Definition at line 73 of file RealFunction.h.

{}

Member Function Documentation

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

Reimplemented in PLearn::ConstantRealFunction, PLearn::RealFunctionFromKernel, PLearn::RealFunctionOfInputFeature, PLearn::RealFunctionProduct, PLearn::RealRangeIndicatorFunction, PLearn::RealValueIndicatorFunction, PLearn::ShiftAndRescaleFeatureRealFunction, and PLearn::TruncatedRealFunction.

Definition at line 52 of file RealFunction.cc.

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

This does the actual building.

Reimplemented from PLearn::Object.

Reimplemented in PLearn::ConstantRealFunction, PLearn::RealFunctionFromKernel, PLearn::RealFunctionOfInputFeature, PLearn::RealFunctionProduct, PLearn::RealRangeIndicatorFunction, PLearn::RealValueIndicatorFunction, PLearn::ShiftAndRescaleFeatureRealFunction, and PLearn::TruncatedRealFunction.

Definition at line 81 of file RealFunction.cc.

{
    // ### This method should do the real building of the object,
    // ### according to set 'options', in *any* situation.
    // ### Typical situations include:
    // ###  - Initial building of an object from a few user-specified options
    // ###  - Building of a "reloaded" object: i.e. from the complete set of
    // ###    all serialised options.
    // ###  - Updating or "re-building" of an object after a few "tuning"
    // ###    options have been modified.
    // ### You should assume that the parent class' build_() has already been
    // ### called.
}
void PLearn::RealFunction::declareOptions ( OptionList ol) [static, protected]

Declares the class options.

Reimplemented from PLearn::Object.

Reimplemented in PLearn::ConstantRealFunction, PLearn::RealFunctionFromKernel, PLearn::RealFunctionOfInputFeature, PLearn::RealFunctionProduct, PLearn::RealRangeIndicatorFunction, PLearn::RealValueIndicatorFunction, PLearn::ShiftAndRescaleFeatureRealFunction, and PLearn::TruncatedRealFunction.

Definition at line 63 of file RealFunction.cc.

References PLearn::OptionBase::buildoption, PLearn::declareOption(), and PLearn::Object::info().

{
    // ### 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, "info", &RealFunction::info,
                  OptionBase::buildoption,
                  "An optional short info string describing the function instance");

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

Here is the call graph for this function:

static const PPath& PLearn::RealFunction::declaringFile ( ) [inline, static]
RealFunction * PLearn::RealFunction::deepCopy ( CopiesMap copies) const [virtual]
virtual real PLearn::RealFunction::evaluate ( const Vec x) const [pure virtual]

Implemented in PLearn::ConstantRealFunction, PLearn::RealFunctionFromKernel, PLearn::RealFunctionOfInputFeature, and PLearn::RealFunctionProduct.

Referenced by operator()().

Here is the caller graph for this function:

string PLearn::RealFunction::getInfo ( ) const [inline]

Definition at line 84 of file RealFunction.h.

References PLearn::Object::info().

    { return info; }

Here is the call graph for this function:

void PLearn::RealFunction::makeDeepCopyFromShallowCopy ( CopiesMap copies) [virtual]
real PLearn::RealFunction::operator() ( const Vec x) const [inline]

Reimplemented in PLearn::ConstantRealFunction.

Definition at line 78 of file RealFunction.h.

References evaluate().

    { return evaluate(x); }

Here is the call graph for this function:

void PLearn::RealFunction::setInfo ( const string &  infostr) [inline]

Definition at line 81 of file RealFunction.h.

References PLearn::Object::info().

Referenced by PLearn::BasisSelectionRegressor::appendCandidateFunctionsOfSingleField().

    { info = infostr; }

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

### declare public option fields (such as build options) here Start your comments with Doxygen-compatible comments such as //!

Optional short info string describing the function instance

Definition at line 68 of file RealFunction.h.


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