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

#include <DatedVMatrix.h>

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

List of all members.

Public Member Functions

 DatedVMatrix ()
 DatedVMatrix (int width, int length)
 default constructor (for automatic deserialization)
virtual VMat subDistrRelativeDates (int first, int n, const string &units)=0
virtual VMat subDistrAbsoluteUnits (int year, int month, int day, int n_units, const string &units)=0
virtual int lengthInDates (const string &units)=0
 return "size" in the given units (e.g. interval in years, months, etc...)
virtual int positionOfRelativeDate (int first, const string &units)=0
 return row position of example whose relative date is the first with the given (relative) value, in the given time units
virtual int nDateFields ()=0
 return the number of real fields required to specify a date
virtual void copyDatesOfRows (int from_row, int n_rows, Mat &dates)=0
 copy the date fields for the relative positions starting at the given row position for the given number of rows, into the given matrix
virtual Vec copyRowDataAndDate (int row, int &year, int &month, int &day)=0
virtual void copyDateOfRow (int row, int &year, int &month, int &day)=0
virtual DatedVMatrixdeepCopy (CopiesMap &copies) const
virtual void build ()
 Simply calls inherited::build() then build_().

Static Public Member Functions

static string _classname_ ()
 DatedVMatrix.
static OptionList_getOptionList_ ()
static RemoteMethodMap_getRemoteMethodMap_ ()
static bool _isa_ (const Object *o)
static void _static_initialize_ ()
static const PPathdeclaringFile ()
static void declareOptions (OptionList &ol)
 Declare this class' options.

Static Public Attributes

static StaticInitializer _static_initializer_

Private Types

typedef VMatrix inherited

Private Member Functions

void build_ ()
 This does the actual building.

Detailed Description

A distribution to which some dates (or more generally time stamps) have been associated to each data row. Special methods then allow to take sub-distributions for particular intervals of dates. This is an abstract class: subclasses specify what time units are available and the semantics of date intervals.

Definition at line 59 of file DatedVMatrix.h.


Member Typedef Documentation

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 61 of file DatedVMatrix.h.


Constructor & Destructor Documentation

PLearn::DatedVMatrix::DatedVMatrix ( ) [inline]

Definition at line 67 of file DatedVMatrix.h.

{}; 
PLearn::DatedVMatrix::DatedVMatrix ( int  width,
int  length 
) [inline]

default constructor (for automatic deserialization)

Definition at line 69 of file DatedVMatrix.h.

: inherited(width,length) {}

Member Function Documentation

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

DatedVMatrix.

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 47 of file DatedVMatrix.cc.

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

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 47 of file DatedVMatrix.cc.

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

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 47 of file DatedVMatrix.cc.

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

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 47 of file DatedVMatrix.cc.

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

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 47 of file DatedVMatrix.cc.

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

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

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 56 of file DatedVMatrix.cc.

Referenced by PLearn::YMDDatedVMatrix::build().

Here is the caller graph for this function:

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

This does the actual building.

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 63 of file DatedVMatrix.cc.

{
}
virtual void PLearn::DatedVMatrix::copyDateOfRow ( int  row,
int year,
int month,
int day 
) [pure virtual]

Implemented in PLearn::YMDDatedVMatrix.

virtual void PLearn::DatedVMatrix::copyDatesOfRows ( int  from_row,
int  n_rows,
Mat dates 
) [pure virtual]

copy the date fields for the relative positions starting at the given row position for the given number of rows, into the given matrix

Implemented in PLearn::YMDDatedVMatrix.

virtual Vec PLearn::DatedVMatrix::copyRowDataAndDate ( int  row,
int year,
int month,
int day 
) [pure virtual]

Implemented in PLearn::YMDDatedVMatrix.

void PLearn::DatedVMatrix::declareOptions ( OptionList ol) [static]

Declare this class' options.

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 50 of file DatedVMatrix.cc.

Referenced by PLearn::YMDDatedVMatrix::declareOptions().

Here is the caller graph for this function:

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

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 104 of file DatedVMatrix.h.

:
    void build_();
DatedVMatrix * PLearn::DatedVMatrix::deepCopy ( CopiesMap copies) const [virtual]

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 47 of file DatedVMatrix.cc.

virtual int PLearn::DatedVMatrix::lengthInDates ( const string &  units) [pure virtual]

return "size" in the given units (e.g. interval in years, months, etc...)

Implemented in PLearn::YMDDatedVMatrix.

virtual int PLearn::DatedVMatrix::nDateFields ( ) [pure virtual]

return the number of real fields required to specify a date

Implemented in PLearn::YMDDatedVMatrix.

virtual int PLearn::DatedVMatrix::positionOfRelativeDate ( int  first,
const string &  units 
) [pure virtual]

return row position of example whose relative date is the first with the given (relative) value, in the given time units

Implemented in PLearn::YMDDatedVMatrix.

virtual VMat PLearn::DatedVMatrix::subDistrAbsoluteUnits ( int  year,
int  month,
int  day,
int  n_units,
const string &  units 
) [pure virtual]

this one calls one of subDistrRelative{Years,Months,Days} according to wether units=="years", "months", or "days" (or if the first letter matches, irrespective of upper/lower case distinctions)

Implemented in PLearn::YMDDatedVMatrix.

virtual VMat PLearn::DatedVMatrix::subDistrRelativeDates ( int  first,
int  n,
const string &  units 
) [pure virtual]

this one calls one of subDistrRelative{Years,Months,Days} according to wether units=="years", "months", or "days" (or if the first letter matches, irrespective of upper/lower case distinctions)

Implemented in PLearn::YMDDatedVMatrix.


Member Data Documentation

Reimplemented from PLearn::VMatrix.

Reimplemented in PLearn::YMDDatedVMatrix.

Definition at line 104 of file DatedVMatrix.h.


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