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

#include <UCISpecification.h>

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

List of all members.

Public Member Functions

 UCISpecification ()
 Default constructor.
virtual string classname () const
virtual OptionListgetOptionList () const
virtual OptionMapgetOptionMap () const
virtual RemoteMethodMapgetRemoteMethodMap () const
virtual UCISpecificationdeepCopy (CopiesMap &copies) const
virtual void build ()
 Post-constructor.
virtual void makeDeepCopyFromShallowCopy (CopiesMap &copies)
 Transforms a shallow copy into a deep copy.

Static Public Member Functions

static string _classname_ ()
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 ()

Public Attributes

bool header_exists
TVec< pair< int, int > > header_fields
PPath data_all
PPath data_test
PPath data_train
string file_all
string file_test
string file_train
string format
int inputsize
int targetsize
int weightsize
bool target_is_first

Static Public Attributes

static StaticInitializer _static_initializer_

Static Protected Member Functions

static void declareOptions (OptionList &ol)
 Declares this class' options.

Private Types

typedef Object inherited

Private Member Functions

void build_ ()
 This does the actual building.

Detailed Description

Definition at line 52 of file UCISpecification.h.


Member Typedef Documentation

Reimplemented from PLearn::Object.

Definition at line 57 of file UCISpecification.h.


Constructor & Destructor Documentation

PLearn::UCISpecification::UCISpecification ( )

Default constructor.

Definition at line 49 of file UCISpecification.cc.


Member Function Documentation

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

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

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

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

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

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

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

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

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

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

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

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

void PLearn::UCISpecification::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::Object.

Definition at line 136 of file UCISpecification.cc.

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

Here is the call graph for this function:

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

This does the actual building.

Reimplemented from PLearn::Object.

Definition at line 124 of file UCISpecification.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::UCISpecification::classname ( ) const [virtual]

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

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

Declares this class' options.

Reimplemented from PLearn::Object.

Definition at line 73 of file UCISpecification.cc.

References PLearn::OptionBase::buildoption, data_all, data_test, data_train, PLearn::declareOption(), PLearn::Object::declareOptions(), file_all, file_test, file_train, format, header_exists, header_fields, inputsize, target_is_first, targetsize, and weightsize.

{
    // ### 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. Another possible flag to be combined with
    // ### is OptionBase::nosave

    declareOption(ol, "header_exists", &UCISpecification::header_exists, OptionBase::buildoption,
                  "Specifies if there is a header for the dataset");

    declareOption(ol, "header_fields", &UCISpecification::header_fields, OptionBase::buildoption,
                  "The fields that are present in the header");

    declareOption(ol, "data_all", &UCISpecification::data_all, OptionBase::buildoption,
                  "Filename for the whole dataset.");

    declareOption(ol, "data_train", &UCISpecification::data_train, OptionBase::buildoption,
                  "Filename for the train data.");

    declareOption(ol, "data_test", &UCISpecification::data_test, OptionBase::buildoption,
                  "Filename for the test data.");

    declareOption(ol, "file_all", &UCISpecification::file_all, OptionBase::buildoption,
                  "DEPRECATED: The filename for the whole dataset");

    declareOption(ol, "file_train", &UCISpecification::file_train, OptionBase::buildoption,
                  "DEPRECATED: The filename for the train data.");

    declareOption(ol, "file_test", &UCISpecification::file_test, OptionBase::buildoption,
                  "DEPRECATED: The filename for the test data.");

    declareOption(ol, "format", &UCISpecification::format, OptionBase::buildoption,
                  "The format of the dataset file.");

    declareOption(ol, "inputsize", &UCISpecification::inputsize, OptionBase::buildoption,
                  "Input size of the data");

    declareOption(ol, "targetsize", &UCISpecification::targetsize, OptionBase::buildoption,
                  "Target size of the data");

    declareOption(ol, "weightsize", &UCISpecification::weightsize, OptionBase::buildoption,
                  "Weight size of the data");

    declareOption(ol, "target_is_first", &UCISpecification::target_is_first, OptionBase::buildoption,
                  "Whether the target is the first column (otherwise it is assumed to be the last one).");

    // Now call the parent class' declareOptions
    inherited::declareOptions(ol);
}

Here is the call graph for this function:

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

Reimplemented from PLearn::Object.

Definition at line 115 of file UCISpecification.h.

UCISpecification * PLearn::UCISpecification::deepCopy ( CopiesMap copies) const [virtual]

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

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

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

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

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

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

Reimplemented from PLearn::Object.

Definition at line 71 of file UCISpecification.cc.

void PLearn::UCISpecification::makeDeepCopyFromShallowCopy ( CopiesMap copies) [virtual]

Transforms a shallow copy into a deep copy.

Reimplemented from PLearn::Object.

Definition at line 142 of file UCISpecification.cc.

References PLearn::Object::makeDeepCopyFromShallowCopy(), and PLERROR.

{
    inherited::makeDeepCopyFromShallowCopy(copies);

    // ### Call deepCopyField on all "pointer-like" fields 
    // ### that you wish to be deepCopied rather than 
    // ### shallow-copied.
    // ### ex:
    // deepCopyField(trainvec, copies);

    // ### Remove this line when you have fully implemented this method.
    PLERROR("UCISpecification::makeDeepCopyFromShallowCopy not fully (correctly) implemented yet!");
}

Here is the call graph for this function:


Member Data Documentation

Reimplemented from PLearn::Object.

Definition at line 115 of file UCISpecification.h.

Definition at line 75 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 76 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 77 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 78 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 79 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 80 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 81 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 73 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 74 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 82 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 85 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 83 of file UCISpecification.h.

Referenced by declareOptions().

Definition at line 84 of file UCISpecification.h.

Referenced by declareOptions().


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