class Parameters

Parameters definition.

Inheritance:

Public Fields

real** data

Array of pointers to array of parameters.

int n_data

Size of data

int* size

size[i] is the size of data[i]

int n_params

Total number of parameters

Public Methods

Parameters()

No parameters ?

Parameters(int n_params_)

Create one entry in data with the given size

void addParameters(real* params, int n_params_, bool do_copy=false)

Add an entry in data.

void add(Parameters* params, bool do_copy=false)

Add all entries given by params in data.

void copy(Parameters* from)

Copy the given parameters.

void copyFrom(real* vec)

Copy a real vector in the parameters.

void copyTo(real* vec)

Copy the full parameters in a real vector.

virtual void saveXFile(XFile* file)

Save all the parameters

virtual void loadXFile(XFile* file)

Load all the parameters

Inherited from Object:

Public Fields

Allocator* allocator

Public Methods

void addOption(const char* name, int size, void* ptr, const char* help="")

void addIOption(const char* name, int* ptr, int init_value, const char* help="")

void addROption(const char* name, real* ptr, real init_value, const char* help="")

void addBOption(const char* name, bool* ptr, bool init_value, const char* help="")

void addOOption(const char* name, Object** ptr, Object* init_value, const char* help="")

void setOption(const char* name, void* ptr)

void setIOption(const char* name, int option)

void setROption(const char* name, real option)

void setBOption(const char* name, bool option)

void setOOption(const char* name, Object* option)

void load(const char* filename)

void save(const char* filename)

void* operator new(size_t size, Allocator* allocator_=NULL)

void* operator new(size_t size, Allocator* allocator_, void* ptr_)

void operator delete(void* ptr)

Documentation

Parameters definition. Parameters are a bench of real arrays.

real** data

Array of pointers to array of parameters. The size of this array is given by n_data. The size of data[i] is given by size[i]

int n_data

Size of data

int* size

size[i] is the size of data[i]

int n_params

Total number of parameters

Parameters()

No parameters ?

Parameters(int n_params_)

Create one entry in data with the given size

void addParameters(real* params, int n_params_, bool do_copy=false)

Add an entry in data. If do_copy is true, copy the parameters. Else, just copy the pointer.

void add(Parameters* params, bool do_copy=false)

Add all entries given by params in data. If do_copy is true, copy the parameters, else just copy the pointers.

void copy(Parameters* from)

Copy the given parameters. The given parameters don't need to have the same structure. But it must have the same total length.

void copyFrom(real* vec)

Copy a real vector in the parameters. The parameters must have the good size!

void copyTo(real* vec)

Copy the full parameters in a real vector. The parameters must have the good size!

virtual void saveXFile(XFile* file)

Save all the parameters

virtual void loadXFile(XFile* file)

Load all the parameters

This class has no child classes.

Author:

Ronan Collobert (collober@idiap.ch)

Alphabetic index HTML hierarchy of classes or Java