PLearn::IndexAtPositionVariable Class Reference

#include <IndexAtPositionVariable.h>

Inheritance diagram for PLearn::IndexAtPositionVariable:

[legend]Collaboration diagram for PLearn::IndexAtPositionVariable:

[legend]List of all members.

Public Member Functions
	IndexAtPositionVariable ()
	Default constructor for persistence.
	IndexAtPositionVariable (Variable *input1, Variable *input2, int the_length, int the_width)
	PLEARN_DECLARE_OBJECT (IndexAtPositionVariable)
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

---

Member Typedef Documentation

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

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

---

Constructor & Destructor Documentation

PLearn::IndexAtPositionVariable::IndexAtPositionVariable (   )  [inline]

Default constructor for persistence. Definition at line 61 of file IndexAtPositionVariable.h.

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

Definition at line 56 of file IndexAtPositionVariable.cc. References build_(), and inherited.

---

Member Function Documentation

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

Implements PLearn::Variable. Definition at line 103 of file IndexAtPositionVariable.cc. References PLearn::Variable::width().

void PLearn::IndexAtPositionVariable::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 IndexAtPositionVariable.cc. References build_().

void PLearn::IndexAtPositionVariable::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 IndexAtPositionVariable.cc. References PLERROR, and width_. Referenced by build(), and IndexAtPositionVariable().

void PLearn::IndexAtPositionVariable::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 81 of file IndexAtPositionVariable.cc. References PLearn::declareOption(), and PLearn::OptionList.

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

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

PLearn::IndexAtPositionVariable::PLEARN_DECLARE_OBJECT (  IndexAtPositionVariable   )

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

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

Reimplemented from PLearn::Variable. Definition at line 119 of file IndexAtPositionVariable.cc. References PLERROR.

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

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

---

Member Data Documentation

int PLearn::IndexAtPositionVariable::length_ [protected]

Definition at line 57 of file IndexAtPositionVariable.h. Referenced by recomputeSize().

int PLearn::IndexAtPositionVariable::width_ [protected]

Definition at line 57 of file IndexAtPositionVariable.h. Referenced by build_(), and recomputeSize().

---

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

• IndexAtPositionVariable.h
• IndexAtPositionVariable.cc

---