class Object

Provides a useful interface for managing options.

Inheritance:


Public Methods

[more] Object()
[more]virtual void init()
Initialize the object.
[more]void addOption(const char* name, int size, void* ptr, const char* help="", bool is_allowed_after_init=false)
Add the option name.
[more]void addIOption(const char* name, int* ptr, int init_value, const char* help="", bool is_allowed_after_init=false)
Several wrappers of addOption() for Int, Real and Bool options.
[more]void addROption(const char* name, real* ptr, real init_value, const char* help="", bool is_allowed_after_init=false)
[more]void addBOption(const char* name, bool* ptr, bool init_value, const char* help="", bool is_allowed_after_init=false)
[more]void setOption(const char* name, void* ptr)
Set the option name to the value contained at ptr
[more]void setIOption(const char* name, int option)
Several wrappers of setOption() for Int, Real and Bool options.
[more]void setROption(const char* name, real option)
[more]void setBOption(const char* name, bool option)
[more]virtual void loadFILE(FILE* file)
Load the object from a file pointer (not the options)
[more]virtual void saveFILE(FILE* file)
Save the object to a file pointer (not the options)
[more]void load(const char* filename)
Load the machine from a file name (not the options)
[more]void save(const char* filename)
Save the machine to a file name (not the options)


Documentation

Provides a useful interface for managing options. Class inherited by almost all classes in Torch.

o Object()

ovirtual void init()
Initialize the object. All objects *MUST* call the init() function of their parents.

ovoid addOption(const char* name, int size, void* ptr, const char* help="", bool is_allowed_after_init=false)
Add the option name. This one has a pointer on ptr and has the size size. You can provide an help in help. (Note that if help is empty, its an empty string and not NULL). If the option can be changed at any time, you can set is_allowed_after_init to true.

ovoid addIOption(const char* name, int* ptr, int init_value, const char* help="", bool is_allowed_after_init=false)
Several wrappers of addOption() for Int, Real and Bool options. Be carefull: there is no type checking.

ovoid addROption(const char* name, real* ptr, real init_value, const char* help="", bool is_allowed_after_init=false)

ovoid addBOption(const char* name, bool* ptr, bool init_value, const char* help="", bool is_allowed_after_init=false)

ovoid setOption(const char* name, void* ptr)
Set the option name to the value contained at ptr

ovoid setIOption(const char* name, int option)
Several wrappers of setOption() for Int, Real and Bool options. Be carefull: there is no type checking.

ovoid setROption(const char* name, real option)

ovoid setBOption(const char* name, bool option)

ovirtual void loadFILE(FILE* file)
Load the object from a file pointer (not the options)

ovirtual void saveFILE(FILE* file)
Save the object to a file pointer (not the options)

ovoid load(const char* filename)
Load the machine from a file name (not the options)

ovoid save(const char* filename)
Save the machine to a file name (not the options)


Direct child classes:
Vec
Trainer
QCCache
Perm
Optimizer
Measurer
Mat
Machine
Kernel
IOTorch
IOHtk
Grammar
EditDistance
Dictionary
DataSet
CmdLine
ClassFormat
Author:
Ronan Collobert (collober@iro.umontreal.ca)

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.