PLearn::RangeVMatrix Class Reference

Outputs scalar samples (length 1) starting at start, up to end (inclusive) with step. When end is reached it starts over again. More...

#include <RangeVMatrix.h>

Inheritance diagram for PLearn::RangeVMatrix:

[legend]Collaboration diagram for PLearn::RangeVMatrix:

[legend]List of all members.

Public Member Functions
	RangeVMatrix ()
	default constructor (for automatic deserialization)
	RangeVMatrix (real the_start, real the_end, real the_step=1.0)
	PLEARN_DECLARE_OBJECT (RangeVMatrix)
virtual void	build ()
	Should call simply inherited::build(), then this class's build_().
virtual real	get (int i, int j) const
	returns element (i,j)
Static Public Member Functions
void	declareOptions (OptionList &ol)
	redefine this in subclasses: call declareOption(...) for each option, and then call inherited::declareOptions(options) ( see the declareOption function further down)
Protected Attributes
real	start
real	end
real	step
Private Types
typedef VMatrix	inherited
Private Member Functions
void	build_ ()
	This does the actual building.

---

Detailed Description

Outputs scalar samples (length 1) starting at start, up to end (inclusive) with step. When end is reached it starts over again.

Definition at line 54 of file RangeVMatrix.h.

---

Member Typedef Documentation

typedef VMatrix PLearn::RangeVMatrix::inherited [private]

Reimplemented from PLearn::VMatrix. Definition at line 56 of file RangeVMatrix.h.

---

Constructor & Destructor Documentation

PLearn::RangeVMatrix::RangeVMatrix (   )

default constructor (for automatic deserialization) Definition at line 50 of file RangeVMatrix.cc.

PLearn::RangeVMatrix::RangeVMatrix (  real  the_start, real  the_end, real  the_step = 1.0 )

Definition at line 55 of file RangeVMatrix.cc. References build().

---

Member Function Documentation

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

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::VMatrix. Definition at line 62 of file RangeVMatrix.cc. References build_(). Referenced by RangeVMatrix().

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

This does the actual building. Reimplemented from PLearn::VMatrix. Definition at line 69 of file RangeVMatrix.cc. References end, start, and step. Referenced by build().

void PLearn::RangeVMatrix::declareOptions (  OptionList &  ol  )  [static]

redefine this in subclasses: call declareOption(...) for each option, and then call inherited::declareOptions(options) ( see the declareOption function further down) ex: static void declareOptions(OptionList& ol) { declareOption(ol, "inputsize", &MyObject::inputsize_, OptionBase::buildoption, "the size of the input\n it must be provided"); declareOption(ol, "weights", &MyObject::weights, OptionBase::learntoption, "the learnt model weights"); inherited::declareOptions(ol); } Reimplemented from PLearn::VMatrix. Definition at line 78 of file RangeVMatrix.cc. References PLearn::declareOption(), and PLearn::OptionList.

real PLearn::RangeVMatrix::get (  int  i, int  j )  const [virtual]

returns element (i,j) Reimplemented from PLearn::VMatrix. Definition at line 86 of file RangeVMatrix.cc. References PLearn::VMatrix::length(), PLERROR, start, and step.

PLearn::RangeVMatrix::PLEARN_DECLARE_OBJECT (  RangeVMatrix   )

---

Member Data Documentation

real PLearn::RangeVMatrix::end [protected]

Definition at line 60 of file RangeVMatrix.h. Referenced by build_().

real PLearn::RangeVMatrix::start [protected]

Definition at line 59 of file RangeVMatrix.h. Referenced by build_(), and get().

real PLearn::RangeVMatrix::step [protected]

Definition at line 61 of file RangeVMatrix.h. Referenced by build_(), and get().

---

The documentation for this class was generated from the following files:

• RangeVMatrix.h
• RangeVMatrix.cc

---