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

#include <Smoother.h>

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

List of all members.

Public Types

typedef Object inherited

Public Member Functions

 Smoother ()
virtual void build ()
 Post-constructor.
virtual void makeDeepCopyFromShallowCopy (CopiesMap &copies)
 Transforms a shallow copy into a deep copy.
virtual SmootherdeepCopy (CopiesMap &copies) const
virtual real smooth (const Vec &source_function, Vec &smoothed_function, Vec bin_positions=Vec(), Vec dest_bin_positions=Vec()) const =0

Static Public Member Functions

static string _classname_ ()
 Declares name and deepCopy methods.
static OptionList_getOptionList_ ()
static RemoteMethodMap_getRemoteMethodMap_ ()
static bool _isa_ (const Object *o)
static void _static_initialize_ ()
static const PPathdeclaringFile ()

Static Public Attributes

static StaticInitializer _static_initializer_

Static Protected Member Functions

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

Private Member Functions

void build_ ()
 This does the actual building.

Detailed Description

Definition at line 49 of file Smoother.h.


Member Typedef Documentation


Constructor & Destructor Documentation

PLearn::Smoother::Smoother ( )

Definition at line 45 of file Smoother.cc.

    :Object()
/* ### Initialise all fields to their default value */
{
    // ...

    // ### You may or may not want to call build_() to finish building the object
    // build_();
}

Member Function Documentation

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

Declares name and deepCopy methods.

Reimplemented from PLearn::Object.

Reimplemented in PLearn::ConditionalCDFSmoother, PLearn::LimitedGaussianSmoother, and PLearn::ScaledConditionalCDFSmoother.

Definition at line 56 of file Smoother.cc.

OptionList & PLearn::Smoother::_getOptionList_ ( ) [static]
RemoteMethodMap & PLearn::Smoother::_getRemoteMethodMap_ ( ) [static]
bool PLearn::Smoother::_isa_ ( const Object o) [static]
StaticInitializer Smoother::_static_initializer_ & PLearn::Smoother::_static_initialize_ ( ) [static]
void PLearn::Smoother::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::ConditionalCDFSmoother, PLearn::LimitedGaussianSmoother, and PLearn::ScaledConditionalCDFSmoother.

Definition at line 87 of file Smoother.cc.

References PLearn::Object::build(), and build_().

Referenced by PLearn::LimitedGaussianSmoother::build(), and PLearn::ConditionalCDFSmoother::build().

Here is the call graph for this function:

Here is the caller graph for this function:

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

This does the actual building.

Reimplemented from PLearn::Object.

Reimplemented in PLearn::ConditionalCDFSmoother, PLearn::LimitedGaussianSmoother, and PLearn::ScaledConditionalCDFSmoother.

Definition at line 75 of file Smoother.cc.

Referenced by build().

{
    // ### 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.
}

Here is the caller graph for this function:

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

Declares this class' options.

Reimplemented from PLearn::Object.

Reimplemented in PLearn::ConditionalCDFSmoother, PLearn::LimitedGaussianSmoother, and PLearn::ScaledConditionalCDFSmoother.

Definition at line 58 of file Smoother.cc.

References PLearn::Object::declareOptions().

Referenced by PLearn::LimitedGaussianSmoother::declareOptions(), and PLearn::ConditionalCDFSmoother::declareOptions().

{
    // ### 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. Another possible flag to be combined with
    // ### is OptionBase::nosave

    // ### ex:
    // declareOption(ol, "myoption", &Smoother::myoption, OptionBase::buildoption,
    //               "Help text describing this option");
    // ...

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Reimplemented from PLearn::Object.

Reimplemented in PLearn::ConditionalCDFSmoother, PLearn::LimitedGaussianSmoother, and PLearn::ScaledConditionalCDFSmoother.

Definition at line 101 of file Smoother.h.

:
    // The source function is either f(i) = source_function[i] as a function of i
Smoother * PLearn::Smoother::deepCopy ( CopiesMap copies) const [virtual]
void PLearn::Smoother::makeDeepCopyFromShallowCopy ( CopiesMap copies) [virtual]

Transforms a shallow copy into a deep copy.

Reimplemented from PLearn::Object.

Reimplemented in PLearn::ConditionalCDFSmoother, PLearn::LimitedGaussianSmoother, and PLearn::ScaledConditionalCDFSmoother.

Definition at line 94 of file Smoother.cc.

References PLearn::Object::makeDeepCopyFromShallowCopy(), and PLERROR.

Referenced by PLearn::LimitedGaussianSmoother::makeDeepCopyFromShallowCopy(), and PLearn::ConditionalCDFSmoother::makeDeepCopyFromShallowCopy().

{
    inherited::makeDeepCopyFromShallowCopy(copies);

    // ### Call deepCopyField on all "pointer-like" fields 
    // ### that you wish to be deepCopied rather than 
    // ### shallow-copied.
    // ### ex:
    // deepCopyField(trainvec, copies);

    // ### Remove this line when you have fully implemented this method.
    PLERROR("Smoother::makeDeepCopyFromShallowCopy not fully (correctly) implemented yet!");
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual real PLearn::Smoother::smooth ( const Vec source_function,
Vec smoothed_function,
Vec  bin_positions = Vec(),
Vec  dest_bin_positions = Vec() 
) const [pure virtual]

Member Data Documentation


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