PLearn::ElementAtPositionVariable Class Reference

#include <ElementAtPositionVariable.h>

Inheritance diagram for PLearn::ElementAtPositionVariable:

[legend]Collaboration diagram for PLearn::ElementAtPositionVariable:

[legend]List of all members.

Public Member Functions
	ElementAtPositionVariable ()
	Default constructor for persistence.
	ElementAtPositionVariable (Variable *input1, Variable *input2, int the_length, int the_width)
	PLEARN_DECLARE_OBJECT (ElementAtPositionVariable)
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
virtual void	rfprop ()
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 BinaryVariable	inherited

---

Detailed Description

A variable of size length() x width(), filled with zeros except for the single element indexed by input2 =(i,j) or input2 = (k). This element will be a copied from input1 (a scalar) (this is used in particular for the symbolic bprop of VarElementVariable)

Definition at line 57 of file ElementAtPositionVariable.h.

---

Member Typedef Documentation

typedef BinaryVariable PLearn::ElementAtPositionVariable::inherited [private]

Reimplemented from PLearn::BinaryVariable. Definition at line 59 of file ElementAtPositionVariable.h. Referenced by ElementAtPositionVariable().

---

Constructor & Destructor Documentation

PLearn::ElementAtPositionVariable::ElementAtPositionVariable (   )  [inline]

Default constructor for persistence. Definition at line 66 of file ElementAtPositionVariable.h.

PLearn::ElementAtPositionVariable::ElementAtPositionVariable (  Variable *  input1, Variable *  input2, int  the_length, int  the_width )

Definition at line 57 of file ElementAtPositionVariable.cc. References build_(), and inherited.

---

Member Function Documentation

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

Implements PLearn::Variable. Definition at line 107 of file ElementAtPositionVariable.cc. References k, and PLearn::Variable::width().

void PLearn::ElementAtPositionVariable::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 64 of file ElementAtPositionVariable.cc. References build_().

void PLearn::ElementAtPositionVariable::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 71 of file ElementAtPositionVariable.cc. References PLERROR. Referenced by build(), and ElementAtPositionVariable().

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

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

compute output given input Implements PLearn::Variable. Definition at line 90 of file ElementAtPositionVariable.cc. References PLearn::TVec< T >::clear(), k, and PLearn::Variable::width().

PLearn::ElementAtPositionVariable::PLEARN_DECLARE_OBJECT (  ElementAtPositionVariable   )

void PLearn::ElementAtPositionVariable::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 87 of file ElementAtPositionVariable.cc. References length_, and width_.

void PLearn::ElementAtPositionVariable::rfprop (   )  [virtual]

Reimplemented from PLearn::Variable. Definition at line 130 of file ElementAtPositionVariable.cc. References PLearn::TVec< T >::clear(), k, PLearn::TVec< T >::length(), PLearn::BinaryVariable::resizeRValue(), and PLearn::Variable::width().

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

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

---

Member Data Documentation

int PLearn::ElementAtPositionVariable::length_ [protected]

Definition at line 62 of file ElementAtPositionVariable.h. Referenced by recomputeSize().

int PLearn::ElementAtPositionVariable::width_ [protected]

Definition at line 62 of file ElementAtPositionVariable.h. Referenced by recomputeSize().

---

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

• ElementAtPositionVariable.h
• ElementAtPositionVariable.cc

---