Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

PLearn::ReshapeVariable Class Reference

Variable that views another variable, but with a different length() and width() (the only restriction being that length()*width() remain the same). More...

#include <ReshapeVariable.h>

Inheritance diagram for PLearn::ReshapeVariable:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ReshapeVariable ()
 Default constructor for persistence.

 ReshapeVariable (Variable *v, int the_length, int the_width)
 PLEARN_DECLARE_OBJECT (ReshapeVariable)
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 length_
int width_

Private Types

typedef UnaryVariable inherited

Detailed Description

Variable that views another variable, but with a different length() and width() (the only restriction being that length()*width() remain the same).

Definition at line 55 of file ReshapeVariable.h.


Member Typedef Documentation

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

Reimplemented from PLearn::UnaryVariable.

Definition at line 57 of file ReshapeVariable.h.

Referenced by ReshapeVariable().


Constructor & Destructor Documentation

PLearn::ReshapeVariable::ReshapeVariable  )  [inline]
 

Default constructor for persistence.

Definition at line 64 of file ReshapeVariable.h.

Referenced by symbolicBprop().

PLearn::ReshapeVariable::ReshapeVariable Variable v,
int  the_length,
int  the_width
 

Definition at line 56 of file ReshapeVariable.cc.

References build_(), and inherited.


Member Function Documentation

void PLearn::ReshapeVariable::bprop  )  [virtual]
 

Implements PLearn::Variable.

Definition at line 96 of file ReshapeVariable.cc.

References k, and PLearn::Variable::nelems().

void PLearn::ReshapeVariable::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 ReshapeVariable.cc.

References build_().

void PLearn::ReshapeVariable::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 ReshapeVariable.cc.

References PLearn::Var::length(), PLearn::Variable::length(), PLERROR, PLearn::Var::width(), and PLearn::Variable::width().

Referenced by build(), and ReshapeVariable().

void PLearn::ReshapeVariable::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 ReshapeVariable.cc.

References PLearn::declareOption(), and PLearn::OptionList.

void PLearn::ReshapeVariable::fprop  )  [virtual]
 

compute output given input

Implements PLearn::Variable.

Definition at line 89 of file ReshapeVariable.cc.

References k, and PLearn::Variable::nelems().

PLearn::ReshapeVariable::PLEARN_DECLARE_OBJECT ReshapeVariable   ) 
 

void PLearn::ReshapeVariable::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 86 of file ReshapeVariable.cc.

References length_, and width_.

void PLearn::ReshapeVariable::symbolicBprop  )  [virtual]
 

compute a piece of new Var graph that represents the symbolic derivative of this Var

Reimplemented from PLearn::Variable.

Definition at line 103 of file ReshapeVariable.cc.

References PLearn::Var::length(), ReshapeVariable(), and PLearn::Var::width().


Member Data Documentation

int PLearn::ReshapeVariable::length_ [protected]
 

Definition at line 60 of file ReshapeVariable.h.

Referenced by recomputeSize().

int PLearn::ReshapeVariable::width_ [protected]
 

Definition at line 60 of file ReshapeVariable.h.

Referenced by recomputeSize().


The documentation for this class was generated from the following files:
Generated on Tue Aug 17 16:25:30 2004 for PLearn by doxygen 1.3.7