PLearn::EqualScalarVariable Class Reference

A scalar var; equal 1 if input1==input2, 0 otherwise. More...

#include <EqualScalarVariable.h>

Inheritance diagram for PLearn::EqualScalarVariable:

[legend]Collaboration diagram for PLearn::EqualScalarVariable:

[legend]List of all members.

Public Member Functions
	EqualScalarVariable ()
	Default constructor for persistence.
	EqualScalarVariable (Variable *input1, Variable *input2)
	PLEARN_DECLARE_OBJECT (EqualScalarVariable)
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 BinaryVariable	inherited

---

Detailed Description

A scalar var; equal 1 if input1==input2, 0 otherwise.

Definition at line 53 of file EqualScalarVariable.h.

---

Member Typedef Documentation

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

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

---

Constructor & Destructor Documentation

PLearn::EqualScalarVariable::EqualScalarVariable (   )  [inline]

Default constructor for persistence. Definition at line 59 of file EqualScalarVariable.h.

PLearn::EqualScalarVariable::EqualScalarVariable (  Variable *  input1, Variable *  input2 )

Definition at line 55 of file EqualScalarVariable.cc. References build_(), and inherited.

---

Member Function Documentation

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

Implements PLearn::Variable. Definition at line 94 of file EqualScalarVariable.cc.

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

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

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

compute output given input Implements PLearn::Variable. Definition at line 85 of file EqualScalarVariable.cc. References PLearn::Variable::nelems().

PLearn::EqualScalarVariable::PLEARN_DECLARE_OBJECT (  EqualScalarVariable   )

void PLearn::EqualScalarVariable::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 76 of file EqualScalarVariable.cc. References PLearn::Var::length(), and PLearn::Var::width().

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

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

---

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

• EqualScalarVariable.h
• EqualScalarVariable.cc

---