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

A HorizonStatefulLearner is a StatefulLearner designed for forecasting at horizon h. More...

#include <HorizonStatefulLearner.h>

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

List of all members.

Public Member Functions

 HorizonStatefulLearner ()
 Default constructor.
virtual void build ()
 Simply calls inherited::build() then build_().
virtual void makeDeepCopyFromShallowCopy (CopiesMap &copies)
 Transforms a shallow copy into a deep copy.
virtual HorizonStatefulLearnerdeepCopy (CopiesMap &copies) const

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

int horizon
 Forecasting horizon for the learner; see detailed class help for interpretation.

Static Public Attributes

static StaticInitializer _static_initializer_

Static Protected Member Functions

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

Private Types

typedef StatefulLearner inherited

Private Member Functions

void build_ ()
 This does the actual building.

Detailed Description

A HorizonStatefulLearner is a StatefulLearner designed for forecasting at horizon h.

It serves as a base class for more specialized forecasters. Contrarily to StatefulLearner, the HorizonStatefulLearner introduces a few additional assumptions on the structure of the training set and the interpretation of the various test methods:

Definition at line 70 of file HorizonStatefulLearner.h.


Member Typedef Documentation

Reimplemented from PLearn::StatefulLearner.

Definition at line 72 of file HorizonStatefulLearner.h.


Constructor & Destructor Documentation

PLearn::HorizonStatefulLearner::HorizonStatefulLearner ( )

Default constructor.

Definition at line 49 of file HorizonStatefulLearner.cc.

    : inherited(), horizon(0)
{}

Member Function Documentation

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

Reimplemented from PLearn::StatefulLearner.

Definition at line 71 of file HorizonStatefulLearner.cc.

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

Reimplemented from PLearn::StatefulLearner.

Definition at line 71 of file HorizonStatefulLearner.cc.

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

Reimplemented from PLearn::StatefulLearner.

Definition at line 71 of file HorizonStatefulLearner.cc.

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

Reimplemented from PLearn::StatefulLearner.

Definition at line 71 of file HorizonStatefulLearner.cc.

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

Reimplemented from PLearn::StatefulLearner.

Definition at line 71 of file HorizonStatefulLearner.cc.

void PLearn::HorizonStatefulLearner::build ( ) [virtual]

Simply calls inherited::build() then build_().

Reimplemented from PLearn::StatefulLearner.

Definition at line 91 of file HorizonStatefulLearner.cc.

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

Here is the call graph for this function:

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

This does the actual building.

Reimplemented from PLearn::StatefulLearner.

Definition at line 84 of file HorizonStatefulLearner.cc.

References horizon, and PLERROR.

Referenced by build().

{
    if (horizon < 0)
        PLERROR("HorizonStatefulLearner::build_: horizon must be non-negative");
}

Here is the caller graph for this function:

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

Declares this class' options.

Reimplemented from PLearn::StatefulLearner.

Definition at line 73 of file HorizonStatefulLearner.cc.

References PLearn::OptionBase::buildoption, PLearn::declareOption(), PLearn::StatefulLearner::declareOptions(), and horizon.

{
    declareOption(
        ol, "horizon", &HorizonStatefulLearner::horizon,
        OptionBase::buildoption,
        "Forecasting horizon for the learner; see detailed class help for\n"
        "interpretation.  (Default value = 0)");

    inherited::declareOptions(ol);
}

Here is the call graph for this function:

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

Reimplemented from PLearn::StatefulLearner.

Definition at line 94 of file HorizonStatefulLearner.h.

:   
HorizonStatefulLearner * PLearn::HorizonStatefulLearner::deepCopy ( CopiesMap copies) const [virtual]

Reimplemented from PLearn::StatefulLearner.

Definition at line 71 of file HorizonStatefulLearner.cc.

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

Transforms a shallow copy into a deep copy.

Reimplemented from PLearn::StatefulLearner.

Definition at line 97 of file HorizonStatefulLearner.cc.

References PLearn::StatefulLearner::makeDeepCopyFromShallowCopy().

Here is the call graph for this function:


Member Data Documentation

Reimplemented from PLearn::StatefulLearner.

Definition at line 94 of file HorizonStatefulLearner.h.

Forecasting horizon for the learner; see detailed class help for interpretation.

(Default value = 0)

Definition at line 79 of file HorizonStatefulLearner.h.

Referenced by build_(), and declareOptions().


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