iCub::ctrl::FunctionEncoder Class Reference

Abstract class to deal with function encoding. More...

#include <functionEncoder.h>

Inheritance diagram for iCub::ctrl::FunctionEncoder:

Public Member Functions
virtual bool	setEncoderOptions (const yarp::os::Property &options)=0
	Configure the encoder.
virtual yarp::os::Property	getEncoderOptions ()=0
	Retrieve the encoder's configuration options.
virtual Code	encode (const yarp::sig::Vector &values)=0
	Encode the function.
virtual double	decode (const Code &code, const double x)=0
	Compute the approximated value of function in x, given the code.
virtual	~FunctionEncoder ()
	Destructor.

Detailed Description

Abstract class to deal with function encoding.

Definition at line 62 of file functionEncoder.h.

Constructor & Destructor Documentation

~FunctionEncoder()

virtual iCub::ctrl::FunctionEncoder::~FunctionEncoder ( )

inlinevirtual

Destructor.

Definition at line 103 of file functionEncoder.h.

Member Function Documentation

decode()

virtual double iCub::ctrl::FunctionEncoder::decode ( const Code &  code, const double  x  )

pure virtual

Compute the approximated value of function in x, given the code.

Parameters

code	contains the function representation in the vector space.
x	is the point at which the result is computed. It shall be in [0,1].

Returns

the decoded function value.

Implemented in iCub::ctrl::WaveletEncoder.

encode()

virtual Code iCub::ctrl::FunctionEncoder::encode ( const yarp::sig::Vector &  values )

pure virtual

Encode the function.

Parameters

values

is the vector containing the samples of function f to be encoded. The x coordinates of the points are intended to be normalized in [0,1], so that f(0)=values[0] and f(1)=values[values.length()-1].

Returns

the code encoding the function f.

Implemented in iCub::ctrl::WaveletEncoder.

getEncoderOptions()

virtual yarp::os::Property iCub::ctrl::FunctionEncoder::getEncoderOptions ( )

pure virtual

Retrieve the encoder's configuration options.

Returns

a Property object containing the encoder's options.

Implemented in iCub::ctrl::WaveletEncoder.

setEncoderOptions()

virtual bool iCub::ctrl::FunctionEncoder::setEncoderOptions ( const yarp::os::Property &  options )

pure virtual

Configure the encoder.

Parameters

options

encoder's options in form of a Property object.

Returns

true/false on success/fail.

Implemented in iCub::ctrl::WaveletEncoder.

---

The documentation for this class was generated from the following file:

• icub-main/src/libraries/ctrlLib/include/iCub/ctrl/functionEncoder.h