PLearn::UnaryHardSlopeVariable Class Reference

#include <UnaryHardSlopeVariable.h>

Inheritance diagram for PLearn::UnaryHardSlopeVariable:

[legend]Collaboration diagram for PLearn::UnaryHardSlopeVariable:

[legend]List of all members.

Public Member Functions
	UnaryHardSlopeVariable ()
	Default constructor for persistence.
	UnaryHardSlopeVariable (Variable *input, real l=-1, real r=1)
	PLEARN_DECLARE_OBJECT (UnaryHardSlopeVariable)
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 ()
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
real	left
real	right
real	inv_slope
Private Types
typedef UnaryVariable	inherited

---

Detailed Description

* Simple unary transform with hard_slope function *

Definition at line 54 of file UnaryHardSlopeVariable.h.

---

Member Typedef Documentation

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

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

---

Constructor & Destructor Documentation

PLearn::UnaryHardSlopeVariable::UnaryHardSlopeVariable (   )  [inline]

Default constructor for persistence. Definition at line 65 of file UnaryHardSlopeVariable.h.

PLearn::UnaryHardSlopeVariable::UnaryHardSlopeVariable (  Variable *  input, real  l = -1, real  r = 1 )

Definition at line 56 of file UnaryHardSlopeVariable.cc. References inherited, PLearn::left(), and PLearn::right().

---

Member Function Documentation

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

Implements PLearn::Variable. Definition at line 102 of file UnaryHardSlopeVariable.cc. References inv_slope, left, PLearn::Variable::nelems(), right, and x.

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

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

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

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

compute output given input Implements PLearn::Variable. Definition at line 92 of file UnaryHardSlopeVariable.cc. References PLearn::hard_slope(), left, PLearn::Variable::nelems(), and right.

PLearn::UnaryHardSlopeVariable::PLEARN_DECLARE_OBJECT (  UnaryHardSlopeVariable   )

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

---

Member Data Documentation

real PLearn::UnaryHardSlopeVariable::inv_slope [protected]

Definition at line 61 of file UnaryHardSlopeVariable.h. Referenced by bprop(), and build_().

real PLearn::UnaryHardSlopeVariable::left [protected]

Definition at line 59 of file UnaryHardSlopeVariable.h. Referenced by bprop(), and fprop().

real PLearn::UnaryHardSlopeVariable::right [protected]

Definition at line 60 of file UnaryHardSlopeVariable.h. Referenced by bprop(), build_(), and fprop().

---

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

• UnaryHardSlopeVariable.h
• UnaryHardSlopeVariable.cc

---