PLearn::VarArrayElementVariable Class Reference

Variable that is the element of the input1 VarArray indexed by the input2 variable. More...

#include <VarArrayElementVariable.h>

Inheritance diagram for PLearn::VarArrayElementVariable:

[legend]Collaboration diagram for PLearn::VarArrayElementVariable:

[legend]List of all members.

Public Member Functions
	VarArrayElementVariable ()
	protected default constructor for persistence
	VarArrayElementVariable (VarArray &input1, const Var &input2)
	PLEARN_DECLARE_OBJECT (VarArrayElementVariable)
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
Protected Member Functions
void	build_ ()
Private Types
typedef NaryVariable	inherited

---

Detailed Description

Variable that is the element of the input1 VarArray indexed by the input2 variable.

Definition at line 55 of file VarArrayElementVariable.h.

---

Member Typedef Documentation

typedef NaryVariable PLearn::VarArrayElementVariable::inherited [private]

Reimplemented from PLearn::NaryVariable. Definition at line 57 of file VarArrayElementVariable.h. Referenced by VarArrayElementVariable().

---

Constructor & Destructor Documentation

PLearn::VarArrayElementVariable::VarArrayElementVariable (   )  [inline]

protected default constructor for persistence Definition at line 61 of file VarArrayElementVariable.h.

PLearn::VarArrayElementVariable::VarArrayElementVariable (  VarArray &  input1, const Var &  input2 )

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

---

Member Function Documentation

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

Implements PLearn::Variable. Definition at line 107 of file VarArrayElementVariable.cc. References PLearn::TVec< Var >::last(), and PLearn::Variable::nelems().

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

void PLearn::VarArrayElementVariable::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 VarArrayElementVariable.cc. References PLearn::TVec< Var >::length(), PLERROR, and PLearn::TVec< Var >::size(). Referenced by build(), and VarArrayElementVariable().

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

compute output given input Implements PLearn::Variable. Definition at line 94 of file VarArrayElementVariable.cc. References PLearn::TVec< Var >::last(), PLearn::Variable::nelems(), PLERROR, and PLearn::TVec< Var >::size().

PLearn::VarArrayElementVariable::PLEARN_DECLARE_OBJECT (  VarArrayElementVariable   )

void PLearn::VarArrayElementVariable::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 VarArrayElementVariable.cc. References PLearn::TVec< Var >::length(), and PLearn::TVec< Var >::size().

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

compute a piece of new Var graph that represents the symbolic derivative of this Var Reimplemented from PLearn::Variable. Definition at line 115 of file VarArrayElementVariable.cc. References PLearn::TVec< Var >::last().

---

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

• VarArrayElementVariable.h
• VarArrayElementVariable.cc

---