PLearn 0.1
Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Private Types | Private Member Functions
PLearn::MemoryVMatrixNoSave Class Reference

The first sentence should be a BRIEF DESCRIPTION of what the class does. More...

#include <MemoryVMatrixNoSave.h>

Inheritance diagram for PLearn::MemoryVMatrixNoSave:
Inheritance graph
[legend]
Collaboration diagram for PLearn::MemoryVMatrixNoSave:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 MemoryVMatrixNoSave ()
 ### declare public option fields (such as build options) here Start your comments with Doxygen-compatible comments such as //!
 MemoryVMatrixNoSave (const Mat &the_data)
 MemoryVMatrixNoSave (int l, int w)
 MemoryVMatrixNoSave (VMat the_source)
virtual string classname () const
virtual OptionListgetOptionList () const
virtual OptionMapgetOptionMap () const
virtual RemoteMethodMapgetRemoteMethodMap () const
virtual MemoryVMatrixNoSavedeepCopy (CopiesMap &copies) const
virtual void build ()
 simply calls inherited::build() then build_()

Static Public Member Functions

static string _classname_ ()
 MemoryVMatrix.
static OptionList_getOptionList_ ()
static RemoteMethodMap_getRemoteMethodMap_ ()
static Object_new_instance_for_typemap_ ()
static bool _isa_ (const Object *o)
static void _static_initialize_ ()
static const PPathdeclaringFile ()

Static Public Attributes

static StaticInitializer _static_initializer_

Static Protected Member Functions

static void declareOptions (OptionList &ol)
 Transforms a shallow copy into a deep copy.

Private Types

typedef MemoryVMatrix inherited

Private Member Functions

void build_ ()
 This does the actual building.

Detailed Description

The first sentence should be a BRIEF DESCRIPTION of what the class does.

Place the rest of the class programmer documentation here. Doxygen supports Javadoc-style comments. See http://www.doxygen.org/manual.html

Todo:
Write class to-do's here if there are any.
Deprecated:
Write deprecated stuff here if there is any. Indicate what else should be used instead.

Definition at line 57 of file MemoryVMatrixNoSave.h.


Member Typedef Documentation

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 59 of file MemoryVMatrixNoSave.h.


Constructor & Destructor Documentation

PLearn::MemoryVMatrixNoSave::MemoryVMatrixNoSave ( )

### declare public option fields (such as build options) here Start your comments with Doxygen-compatible comments such as //!

Default constructor

Definition at line 54 of file MemoryVMatrixNoSave.cc.

    : inherited()
/* ### Initialize all fields to their default value here */
{
    // ...

    // ### You may (or not) want to call build_() to finish building the object
    // ### (doing so assumes the parent classes' build_() have been called too
    // ### in the parent classes' constructors, something that you must ensure)
}
PLearn::MemoryVMatrixNoSave::MemoryVMatrixNoSave ( const Mat the_data)

Definition at line 67 of file MemoryVMatrixNoSave.cc.

    : inherited(the_data)
{}
PLearn::MemoryVMatrixNoSave::MemoryVMatrixNoSave ( int  l,
int  w 
)

Definition at line 64 of file MemoryVMatrixNoSave.cc.

    : inherited(l,w)
{}
PLearn::MemoryVMatrixNoSave::MemoryVMatrixNoSave ( VMat  the_source)

Definition at line 70 of file MemoryVMatrixNoSave.cc.

    : inherited(the_source)
{}

Member Function Documentation

string PLearn::MemoryVMatrixNoSave::_classname_ ( ) [static]

MemoryVMatrix.

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

OptionList & PLearn::MemoryVMatrixNoSave::_getOptionList_ ( ) [static]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

RemoteMethodMap & PLearn::MemoryVMatrixNoSave::_getRemoteMethodMap_ ( ) [static]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

bool PLearn::MemoryVMatrixNoSave::_isa_ ( const Object o) [static]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

Object * PLearn::MemoryVMatrixNoSave::_new_instance_for_typemap_ ( ) [static]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

StaticInitializer MemoryVMatrixNoSave::_static_initializer_ & PLearn::MemoryVMatrixNoSave::_static_initialize_ ( ) [static]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

void PLearn::MemoryVMatrixNoSave::build ( ) [virtual]

simply calls inherited::build() then build_()

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 104 of file MemoryVMatrixNoSave.cc.

References PLearn::MemoryVMatrix::build(), and build_().

Here is the call graph for this function:

void PLearn::MemoryVMatrixNoSave::build_ ( ) [private]

This does the actual building.

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 113 of file MemoryVMatrixNoSave.cc.

Referenced by build().

{
    // ### This method should do the real building of the object,
    // ### according to set 'options', in *any* situation.
    // ### Typical situations include:
    // ###  - Initial building of an object from a few user-specified options
    // ###  - Building of a "reloaded" object: i.e. from the complete set of
    // ###    all serialised options.
    // ###  - Updating or "re-building" of an object after a few "tuning"
    // ###    options have been modified.
    // ### You should assume that the parent class' build_() has already been
    // ### called.
}

Here is the caller graph for this function:

string PLearn::MemoryVMatrixNoSave::classname ( ) const [virtual]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

void PLearn::MemoryVMatrixNoSave::declareOptions ( OptionList ol) [static, protected]

Transforms a shallow copy into a deep copy.

Declares the class options.

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 77 of file MemoryVMatrixNoSave.cc.

References PLearn::OptionBase::buildoption, PLearn::MemoryVMatrix::data, PLearn::MemoryVMatrix::declareOptions(), PLearn::OptionBase::nosave, and PLearn::redeclareOption().

{
    // ### Declare all of this object's options here.
    // ### For the "flags" of each option, you should typically specify
    // ### one of OptionBase::buildoption, OptionBase::learntoption or
    // ### OptionBase::tuningoption. If you don't provide one of these three,
    // ### this option will be ignored when loading values from a script.
    // ### You can also combine flags, for example with OptionBase::nosave:
    // ### (OptionBase::buildoption | OptionBase::nosave)

    // ### ex:
    // declareOption(ol, "myoption", &MemoryVMatrixNoSave::myoption,
    //               OptionBase::buildoption,
    //               "Help text describing this option");
    // ...

    // Now call the parent class' declareOptions
    inherited::declareOptions(ol);
    redeclareOption(ol, "data", &MemoryVMatrix::data,
                    OptionBase::buildoption|OptionBase::nosave,
                    "The external Mat source. Not saved");

}

Here is the call graph for this function:

static const PPath& PLearn::MemoryVMatrixNoSave::declaringFile ( ) [inline, static]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 83 of file MemoryVMatrixNoSave.h.

:
    //#####  Protected Options  ###############################################
MemoryVMatrixNoSave * PLearn::MemoryVMatrixNoSave::deepCopy ( CopiesMap copies) const [virtual]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

OptionList & PLearn::MemoryVMatrixNoSave::getOptionList ( ) const [virtual]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

OptionMap & PLearn::MemoryVMatrixNoSave::getOptionMap ( ) const [virtual]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.

RemoteMethodMap & PLearn::MemoryVMatrixNoSave::getRemoteMethodMap ( ) const [virtual]

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 49 of file MemoryVMatrixNoSave.cc.


Member Data Documentation

Reimplemented from PLearn::MemoryVMatrix.

Definition at line 83 of file MemoryVMatrixNoSave.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines