PLearn::SubsampleVariable Class Reference

A subsample var; equals subrample(input, the_subsamplefactor). More...

#include <SubsampleVariable.h>

Inheritance diagram for PLearn::SubsampleVariable:

[legend]Collaboration diagram for PLearn::SubsampleVariable:

[legend]List of all members.

Public Member Functions
	SubsampleVariable ()
	Default constructor for persistence.
	SubsampleVariable (Variable *input, int the_subsamplefactor)
	PLEARN_DECLARE_OBJECT (SubsampleVariable)
virtual void	build ()
	Should call simply inherited::build(), then this class's build_().
virtual void	recomputeSize (int &l, int &w) const
	Recomputes the length l and width w that this variable should have, according to its parent variables.
virtual void	fprop ()
	compute output given input
virtual void	bprop ()
virtual void	symbolicBprop ()
	compute a piece of new Var graph that represents the symbolic derivative of this Var
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 Member Functions
void	build_ ()
Protected Attributes
int	subsamplefactor
Private Types
typedef UnaryVariable	inherited

---

Detailed Description

A subsample var; equals subrample(input, the_subsamplefactor).

Definition at line 53 of file SubsampleVariable.h.

---

Member Typedef Documentation

typedef UnaryVariable PLearn::SubsampleVariable::inherited [private]

Reimplemented from PLearn::UnaryVariable. Definition at line 55 of file SubsampleVariable.h. Referenced by SubsampleVariable().

---

Constructor & Destructor Documentation

PLearn::SubsampleVariable::SubsampleVariable (   )  [inline]

Default constructor for persistence. Definition at line 62 of file SubsampleVariable.h. References subsamplefactor.

PLearn::SubsampleVariable::SubsampleVariable (  Variable *  input, int  the_subsamplefactor )

Definition at line 55 of file SubsampleVariable.cc. References build_(), and inherited.

---

Member Function Documentation

void PLearn::SubsampleVariable::bprop (   )  [virtual]

Implements PLearn::Variable. Definition at line 100 of file SubsampleVariable.cc. References PLearn::Variable::length(), PLearn::norm(), subsamplefactor, and PLearn::Variable::width().

void PLearn::SubsampleVariable::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::Variable. Definition at line 63 of file SubsampleVariable.cc. References build_().

void PLearn::SubsampleVariable::build_ (   )  [protected]

This method should be redefined in subclasses and do the actual building of the object according to previously set option fields. Constructors can just set option fields, and then call build_. This method is NOT virtual, and will typically be called only from three places: a constructor, the public virtual build() method, and possibly the public virtual read method (which calls its parent's read). build_() can assume that it's parent's build_ has already been called. Reimplemented from PLearn::Variable. Definition at line 70 of file SubsampleVariable.cc. References PLearn::Var::length(), PLERROR, subsamplefactor, and PLearn::Var::width(). Referenced by build(), and SubsampleVariable().

void PLearn::SubsampleVariable::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::UnaryVariable. Definition at line 79 of file SubsampleVariable.cc. References PLearn::declareOption(), and PLearn::OptionList.

void PLearn::SubsampleVariable::fprop (   )  [virtual]

compute output given input Implements PLearn::Variable. Definition at line 94 of file SubsampleVariable.cc. References PLearn::subsample(), and subsamplefactor.

PLearn::SubsampleVariable::PLEARN_DECLARE_OBJECT (  SubsampleVariable   )

void PLearn::SubsampleVariable::recomputeSize (  int &  l, int &  w )  const [virtual]

Recomputes the length l and width w that this variable should have, according to its parent variables. This is used for ex. by sizeprop() The default version stupidly returns the current dimensions, so make sure to overload it in subclasses if this is not appropriate. Reimplemented from PLearn::Variable. Definition at line 85 of file SubsampleVariable.cc. References PLearn::Var::length(), subsamplefactor, and PLearn::Var::width().

void PLearn::SubsampleVariable::symbolicBprop (   )  [virtual]

compute a piece of new Var graph that represents the symbolic derivative of this Var Reimplemented from PLearn::Variable. Definition at line 117 of file SubsampleVariable.cc. References PLERROR.

---

Member Data Documentation

int PLearn::SubsampleVariable::subsamplefactor [protected]

Definition at line 58 of file SubsampleVariable.h. Referenced by bprop(), build_(), fprop(), recomputeSize(), and SubsampleVariable().

---

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

• SubsampleVariable.h
• SubsampleVariable.cc

---