PLearn 0.1
|
Variable that is the element of vector vec indexed by variable input. More...
#include <VecElementVariable.h>
Public Member Functions | |
VecElementVariable () | |
Default constructor for persistence. | |
VecElementVariable (const Vec &vec, Variable *input) | |
virtual string | classname () const |
virtual OptionList & | getOptionList () const |
virtual OptionMap & | getOptionMap () const |
virtual RemoteMethodMap & | getRemoteMethodMap () const |
virtual VecElementVariable * | deepCopy (CopiesMap &copies) const |
virtual void | build () |
Post-constructor. | |
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 (CopiesMap &copies) |
Does the necessary operations to transform a shallow copy (this) into a deep copy by deep-copying all the members that need to be. | |
virtual void | fprop () |
Nothing to do by default. | |
virtual void | bprop () |
Nothing to do by default. | |
virtual void | symbolicBprop () |
compute a piece of new Var graph that represents the symbolic derivative of this Var | |
Static Public Member Functions | |
static string | _classname_ () |
VecElementVariable. | |
static OptionList & | _getOptionList_ () |
static RemoteMethodMap & | _getRemoteMethodMap_ () |
static Object * | _new_instance_for_typemap_ () |
static bool | _isa_ (const Object *o) |
static void | _static_initialize_ () |
static const PPath & | declaringFile () |
static void | declareOptions (OptionList &ol) |
Declare options (data fields) for the class. | |
Static Public Attributes | |
static StaticInitializer | _static_initializer_ |
Protected Member Functions | |
void | build_ () |
Object-specific post-constructor. | |
Protected Attributes | |
Vec | v |
Private Types | |
typedef UnaryVariable | inherited |
Variable that is the element of vector vec indexed by variable input.
Definition at line 53 of file VecElementVariable.h.
typedef UnaryVariable PLearn::VecElementVariable::inherited [private] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 55 of file VecElementVariable.h.
PLearn::VecElementVariable::VecElementVariable | ( | ) | [inline] |
string PLearn::VecElementVariable::_classname_ | ( | ) | [static] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
OptionList & PLearn::VecElementVariable::_getOptionList_ | ( | ) | [static] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
RemoteMethodMap & PLearn::VecElementVariable::_getRemoteMethodMap_ | ( | ) | [static] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
Object * PLearn::VecElementVariable::_new_instance_for_typemap_ | ( | ) | [static] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
StaticInitializer VecElementVariable::_static_initializer_ & PLearn::VecElementVariable::_static_initialize_ | ( | ) | [static] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
void PLearn::VecElementVariable::bprop | ( | ) | [virtual] |
Nothing to do by default.
Reimplemented from PLearn::UnaryVariable.
Definition at line 97 of file VecElementVariable.cc.
{}
void PLearn::VecElementVariable::build | ( | ) | [virtual] |
Post-constructor.
The normal implementation 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::UnaryVariable.
Definition at line 62 of file VecElementVariable.cc.
References PLearn::UnaryVariable::build(), and build_().
{ inherited::build(); build_(); }
void PLearn::VecElementVariable::build_ | ( | ) | [protected] |
Object-specific post-constructor.
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 its parent's build_()
has already been called.
Reimplemented from PLearn::UnaryVariable.
Definition at line 69 of file VecElementVariable.cc.
References PLearn::UnaryVariable::input, and PLERROR.
Referenced by build(), and VecElementVariable().
{ if(input && !input->isScalar()) PLERROR("IN VecElementVariable(const Vec& vec, Variable* input) input must have nelems() 1 as it is supposed to be an integer index"); }
string PLearn::VecElementVariable::classname | ( | ) | const [virtual] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
void PLearn::VecElementVariable::declareOptions | ( | OptionList & | ol | ) | [static] |
Declare options (data fields) for the class.
Redefine this in subclasses: call declareOption
(...) for each option, and then call inherited::declareOptions(options)
. Please call the inherited
method AT THE END to get the options listed in a consistent order (from most recently defined to least recently defined).
static void MyDerivedClass::declareOptions(OptionList& ol) { declareOption(ol, "inputsize", &MyObject::inputsize_, OptionBase::buildoption, "The size of the input; it must be provided"); declareOption(ol, "weights", &MyObject::weights, OptionBase::learntoption, "The learned model weights"); inherited::declareOptions(ol); }
ol | List of options that is progressively being constructed for the current class. |
Reimplemented from PLearn::UnaryVariable.
Definition at line 76 of file VecElementVariable.cc.
References PLearn::OptionBase::buildoption, PLearn::declareOption(), PLearn::UnaryVariable::declareOptions(), and v.
{ declareOption(ol, "v", &VecElementVariable::v, OptionBase::buildoption, ""); inherited::declareOptions(ol); }
static const PPath& PLearn::VecElementVariable::declaringFile | ( | ) | [inline, static] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 65 of file VecElementVariable.h.
: void build_();
VecElementVariable * PLearn::VecElementVariable::deepCopy | ( | CopiesMap & | copies | ) | const [virtual] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
void PLearn::VecElementVariable::fprop | ( | ) | [virtual] |
Nothing to do by default.
Reimplemented from PLearn::UnaryVariable.
Definition at line 93 of file VecElementVariable.cc.
References PLearn::UnaryVariable::input, v, and PLearn::Variable::valuedata.
OptionList & PLearn::VecElementVariable::getOptionList | ( | ) | const [virtual] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
OptionMap & PLearn::VecElementVariable::getOptionMap | ( | ) | const [virtual] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
RemoteMethodMap & PLearn::VecElementVariable::getRemoteMethodMap | ( | ) | const [virtual] |
Reimplemented from PLearn::UnaryVariable.
Definition at line 53 of file VecElementVariable.cc.
void PLearn::VecElementVariable::makeDeepCopyFromShallowCopy | ( | CopiesMap & | copies | ) | [virtual] |
Does the necessary operations to transform a shallow copy (this) into a deep copy by deep-copying all the members that need to be.
This needs to be overridden by every class that adds "complex" data members to the class, such as Vec
, Mat
, PP<Something>
, etc. Typical implementation:
void CLASS_OF_THIS::makeDeepCopyFromShallowCopy(CopiesMap& copies) { inherited::makeDeepCopyFromShallowCopy(copies); deepCopyField(complex_data_member1, copies); deepCopyField(complex_data_member2, copies); ... }
copies | A map used by the deep-copy mechanism to keep track of already-copied objects. |
Reimplemented from PLearn::UnaryVariable.
Definition at line 85 of file VecElementVariable.cc.
References PLearn::deepCopyField(), PLearn::UnaryVariable::makeDeepCopyFromShallowCopy(), and v.
{ inherited::makeDeepCopyFromShallowCopy(copies); deepCopyField(v, copies); }
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.
{ l=1; w=1; }
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.
{}
Reimplemented from PLearn::UnaryVariable.
Definition at line 65 of file VecElementVariable.h.
Vec PLearn::VecElementVariable::v [protected] |
Definition at line 58 of file VecElementVariable.h.
Referenced by declareOptions(), fprop(), and makeDeepCopyFromShallowCopy().