PLearn::VecElementVariable Class Reference

Variable that is the element of vector vec indexed by variable input. More...

#include <VecElementVariable.h>

Inheritance diagram for PLearn::VecElementVariable:

[legend]Collaboration diagram for PLearn::VecElementVariable:

[legend]List of all members.

Public Member Functions
	VecElementVariable ()
	Default constructor for persistence.
	VecElementVariable (const Vec &vec, Variable *input)
	PLEARN_DECLARE_OBJECT (VecElementVariable)
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	makeDeepCopyFromShallowCopy (map< const void *, void * > &copies)
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
Vec	v
Private Types
typedef UnaryVariable	inherited

---

Detailed Description

Variable that is the element of vector vec indexed by variable input.

Definition at line 53 of file VecElementVariable.h.

---

Member Typedef Documentation

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

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

---

Constructor & Destructor Documentation

PLearn::VecElementVariable::VecElementVariable (   )  [inline]

Default constructor for persistence. Definition at line 62 of file VecElementVariable.h.

PLearn::VecElementVariable::VecElementVariable (  const Vec &  vec, Variable *  input )

Definition at line 55 of file VecElementVariable.cc. References build_(), inherited, and PLearn::Vec.

---

Member Function Documentation

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

Implements PLearn::Variable. Definition at line 97 of file VecElementVariable.cc.

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

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

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

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

compute output given input Implements PLearn::Variable. Definition at line 93 of file VecElementVariable.cc. References v.

void PLearn::VecElementVariable::makeDeepCopyFromShallowCopy (  map< const void *, void * > &  copies  )  [virtual]

Reimplemented from PLearn::UnaryVariable. Definition at line 85 of file VecElementVariable.cc. References PLearn::deepCopyField(), and v.

PLearn::VecElementVariable::PLEARN_DECLARE_OBJECT (  VecElementVariable   )

void PLearn::VecElementVariable::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 82 of file VecElementVariable.cc.

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

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

---

Member Data Documentation

Vec PLearn::VecElementVariable::v [protected]

Definition at line 58 of file VecElementVariable.h. Referenced by fprop(), and makeDeepCopyFromShallowCopy().

---

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

• VecElementVariable.h
• VecElementVariable.cc

---