PLearn 0.1
|
The first sentence should be a BRIEF DESCRIPTION of what the class does. More...
#include <RealFunction.h>
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 RealFunction * | 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 bool | _isa_ (const Object *o) |
static void | _static_initialize_ () |
static const PPath & | declaringFile () |
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. |
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 57 of file RealFunction.h.
typedef Object PLearn::RealFunction::inherited [private] |
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 59 of file RealFunction.h.
PLearn::RealFunction::RealFunction | ( | ) | [inline] |
Definition at line 73 of file RealFunction.h.
{}
string PLearn::RealFunction::_classname_ | ( | ) | [static] |
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 49 of file RealFunction.cc.
OptionList & PLearn::RealFunction::_getOptionList_ | ( | ) | [static] |
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 49 of file RealFunction.cc.
RemoteMethodMap & PLearn::RealFunction::_getRemoteMethodMap_ | ( | ) | [static] |
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 49 of file RealFunction.cc.
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 49 of file RealFunction.cc.
StaticInitializer RealFunction::_static_initializer_ & PLearn::RealFunction::_static_initialize_ | ( | ) | [static] |
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 49 of file RealFunction.cc.
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.
{ inherited::build(); build_(); }
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); }
static const PPath& PLearn::RealFunction::declaringFile | ( | ) | [inline, static] |
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 93 of file RealFunction.h.
:
//##### Protected Options ###############################################
RealFunction * PLearn::RealFunction::deepCopy | ( | CopiesMap & | copies | ) | const [virtual] |
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 49 of file RealFunction.cc.
Implemented in PLearn::ConstantRealFunction, PLearn::RealFunctionFromKernel, PLearn::RealFunctionOfInputFeature, and PLearn::RealFunctionProduct.
Referenced by operator()().
string PLearn::RealFunction::getInfo | ( | ) | const [inline] |
Definition at line 84 of file RealFunction.h.
References PLearn::Object::info().
{ return info; }
void PLearn::RealFunction::makeDeepCopyFromShallowCopy | ( | CopiesMap & | copies | ) | [virtual] |
Transforms a shallow copy into a deep copy.
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 58 of file RealFunction.cc.
{ inherited::makeDeepCopyFromShallowCopy(copies); }
Reimplemented in PLearn::ConstantRealFunction.
Definition at line 78 of file RealFunction.h.
References evaluate().
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; }
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 93 of file RealFunction.h.
string PLearn::RealFunction::info |
### 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.