This is basic implementation of the LSSVM algorithms. More...

#include <LSSVMLearner.h>

Inheritance diagram for iCub::learningmachine::LSSVMLearner:

Public Member Functions
	LSSVMLearner (unsigned int dom=1, unsigned int cod=1, double c=1.0)
	Constructor.

	LSSVMLearner (const LSSVMLearner &other)
	Copy Constructor.

virtual	~LSSVMLearner ()
	Destructor.

virtual LSSVMLearner &	operator= (const LSSVMLearner &other)
	Assignment operator.

virtual void	feedSample (const yarp::sig::Vector &input, const yarp::sig::Vector &output)
	Provide the learning machine with an example of the desired mapping.

virtual void	train ()
	Train the learning machine on the examples that have been supplied so far.

Prediction	predict (const yarp::sig::Vector &input)
	Ask the learning machine to predict the output for a given input.

void	reset ()
	Forget everything and start over.

LSSVMLearner *	clone ()
	Asks the learning machine to return a clone of its type.

virtual std::string	getInfo ()
	Asks the learning machine to return a string containing information on its operation so far.

virtual std::string	getConfigHelp ()
	Asks the learning machine to return a string containing the list of configuration options that it supports.

virtual void	writeBottle (yarp::os::Bottle &bot)

virtual void	readBottle (yarp::os::Bottle &bot)
	Unserializes a machine from a bottle.

void	setDomainSize (unsigned int size)
	Mutator for the domain size.

void	setCoDomainSize (unsigned int size)
	Mutator for the codomain size.

virtual bool	configure (yarp::os::Searchable &config)
	Change parameters.

virtual void	setC (double C)
	Mutator for the regularization parameter C.

virtual double	getC ()
	Accessor for the regularization parameter C.

virtual RBFKernel *	getKernel ()
	Accessor for the kernel.

Public Member Functions inherited from iCub::learningmachine::IFixedSizeLearner
	IFixedSizeLearner (unsigned int dom=1, unsigned int cod=1)
	Constructor.

unsigned int	getDomainSize () const
	Returns the size (dimensionality) of the input domain.

unsigned int	getCoDomainSize () const
	Returns the size (dimensionality) of the output domain (codomain).

Public Member Functions inherited from iCub::learningmachine::IMachineLearner
	IMachineLearner ()
	Constructor.

virtual	~IMachineLearner ()
	Destructor (empty).

virtual bool	open (yarp::os::Searchable &config)
	Initialize the object.

virtual bool	close ()
	Shut the object down.

bool	write (yarp::os::ConnectionWriter &connection) const

bool	read (yarp::os::ConnectionReader &connection)

virtual std::string	toString ()
	Asks the learning machine to return a string serialization.

virtual bool	fromString (const std::string &str)
	Asks the learning machine to initialize from a string serialization.

std::string	getName () const
	Retrieve the name of this machine learning technique.

void	setName (const std::string &name)
	Set the name of this machine learning technique.

Additional Inherited Members
Protected Member Functions inherited from iCub::learningmachine::IFixedSizeLearner
virtual bool	checkDomainSize (const yarp::sig::Vector &input)
	Checks whether the input is of the desired dimensionality.

virtual bool	checkCoDomainSize (const yarp::sig::Vector &output)
	Checks whether the output is of the desired dimensionality.

void	validateDomainSizes (const yarp::sig::Vector &input, const yarp::sig::Vector &output)
	Validates whether the input and output are of the desired dimensionality.

virtual void	writeBottle (yarp::os::Bottle &bot) const
	Writes a serialization of the machine into a bottle.

Protected Attributes inherited from iCub::learningmachine::IFixedSizeLearner
unsigned int	domainSize
	The dimensionality of the input domain.

unsigned int	coDomainSize
	The dimensionality of the output domain (codomain).

Protected Attributes inherited from iCub::learningmachine::IMachineLearner
std::string	name
	The name of this type of machine learner.

Detailed Description

This is basic implementation of the LSSVM algorithms.

Note that for efficiency the hyperparameters are shared among all outputs. Only the RBF kernel function is supported.

See also: iCub::contrib::IMachineLearner; iCub::contrib::IFixedSizeLearner

Author: Arjan Gijsberts

Definition at line 120 of file LSSVMLearner.h.

Constructor & Destructor Documentation

◆ LSSVMLearner() [1/2]

iCub::learningmachine::LSSVMLearner::LSSVMLearner	(	unsigned int	dom = `1`,
		unsigned int	cod = `1`,
		double	c = `1.0`
	)

Constructor.

Parameters

dom	initial domain size
cod	initial codomain size
c	initial value for regularization parameter C

Definition at line 49 of file LSSVMLearner.cpp.

◆ LSSVMLearner() [2/2]

iCub::learningmachine::LSSVMLearner::LSSVMLearner ( const LSSVMLearner & other )

Copy Constructor.

Definition at line 59 of file LSSVMLearner.cpp.

◆ ~LSSVMLearner()

iCub::learningmachine::LSSVMLearner::~LSSVMLearner ( )

virtual

Destructor.

Definition at line 66 of file LSSVMLearner.cpp.

Member Function Documentation

◆ clone()

LSSVMLearner * iCub::learningmachine::LSSVMLearner::clone ( )

virtual

Asks the learning machine to return a clone of its type.

Returns: a clone of the current learner

Implements iCub::learningmachine::IMachineLearner.

Definition at line 169 of file LSSVMLearner.cpp.

◆ configure()

bool iCub::learningmachine::LSSVMLearner::configure ( yarp::os::Searchable & config )

virtual

Change parameters.

Reimplemented from iCub::learningmachine::IFixedSizeLearner.

Definition at line 256 of file LSSVMLearner.cpp.

◆ feedSample()

void iCub::learningmachine::LSSVMLearner::feedSample	(	const yarp::sig::Vector &	input,
		const yarp::sig::Vector &	output
	)

virtual

Provide the learning machine with an example of the desired mapping.

Parameters

input	a sample input
output	the corresponding output

Reimplemented from iCub::learningmachine::IFixedSizeLearner.

Definition at line 86 of file LSSVMLearner.cpp.

◆ getC()

virtual double iCub::learningmachine::LSSVMLearner::getC ( )

inlinevirtual

Accessor for the regularization parameter C.

Returns: the value of the parameter

Definition at line 257 of file LSSVMLearner.h.

◆ getConfigHelp()

std::string iCub::learningmachine::LSSVMLearner::getConfigHelp ( )

virtual

Asks the learning machine to return a string containing the list of configuration options that it supports.

Returns: an informative description of the configuration options

Reimplemented from iCub::learningmachine::IFixedSizeLearner.

Definition at line 184 of file LSSVMLearner.cpp.

◆ getInfo()

std::string iCub::learningmachine::LSSVMLearner::getInfo ( )

virtual

Asks the learning machine to return a string containing information on its operation so far.

Returns: the information on the machine

Reimplemented from iCub::learningmachine::IFixedSizeLearner.

Definition at line 173 of file LSSVMLearner.cpp.

◆ getKernel()

virtual RBFKernel * iCub::learningmachine::LSSVMLearner::getKernel ( )

inlinevirtual

Accessor for the kernel.

Returns: a pointer to the kernel

Definition at line 266 of file LSSVMLearner.h.

◆ operator=()

LSSVMLearner & iCub::learningmachine::LSSVMLearner::operator= ( const LSSVMLearner & other )

virtual

Assignment operator.

Definition at line 70 of file LSSVMLearner.cpp.

◆ predict()

Prediction iCub::learningmachine::LSSVMLearner::predict ( const yarp::sig::Vector & input )

virtual

Ask the learning machine to predict the output for a given input.

Parameters

input the input

Returns: the expected output

Implements iCub::learningmachine::IMachineLearner.

Definition at line 145 of file LSSVMLearner.cpp.

◆ readBottle()

void iCub::learningmachine::LSSVMLearner::readBottle ( yarp::os::Bottle & bot )

virtual

Unserializes a machine from a bottle.

This method is internally referenced by the read method. Typically, subclasses should override this method instead of overriding the read method directly.

Parameters

bot	the bottle

Reimplemented from iCub::learningmachine::IFixedSizeLearner.

Definition at line 218 of file LSSVMLearner.cpp.

◆ reset()

void iCub::learningmachine::LSSVMLearner::reset ( )

virtual

Forget everything and start over.

Implements iCub::learningmachine::IMachineLearner.

Definition at line 161 of file LSSVMLearner.cpp.

◆ setC()

virtual void iCub::learningmachine::LSSVMLearner::setC ( double C )

inlinevirtual

Mutator for the regularization parameter C.

Parameters

C	the new value

Definition at line 248 of file LSSVMLearner.h.

◆ setCoDomainSize()

void iCub::learningmachine::LSSVMLearner::setCoDomainSize ( unsigned int size )

virtual

Mutator for the codomain size.

Parameters

size	the desired codomain size

Reimplemented from iCub::learningmachine::IFixedSizeLearner.

Definition at line 251 of file LSSVMLearner.cpp.

◆ setDomainSize()

void iCub::learningmachine::LSSVMLearner::setDomainSize ( unsigned int size )

virtual

Mutator for the domain size.

Parameters

size	the desired domain size

Reimplemented from iCub::learningmachine::IFixedSizeLearner.

Definition at line 247 of file LSSVMLearner.cpp.

◆ train()

void iCub::learningmachine::LSSVMLearner::train ( )

virtual

Train the learning machine on the examples that have been supplied so far.

This method is primarily intended to be used for offline/batch learning machines. It explicitly initiates the training routine on those machines for the samples that have been collected so far.

Reimplemented from iCub::learningmachine::IFixedSizeLearner.

Definition at line 94 of file LSSVMLearner.cpp.

◆ writeBottle()

void iCub::learningmachine::LSSVMLearner::writeBottle ( yarp::os::Bottle & bot )

virtual

Definition at line 193 of file LSSVMLearner.cpp.

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

icub-main/src/libraries/learningMachine/include/iCub/learningMachine/LSSVMLearner.h
icub-main/src/libraries/learningMachine/src/LSSVMLearner.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LSSVMLearner() [1/2]

◆ LSSVMLearner() [2/2]

◆ ~LSSVMLearner()

Member Function Documentation

◆ clone()

◆ configure()

◆ feedSample()

◆ getC()

◆ getConfigHelp()

◆ getInfo()

◆ getKernel()

◆ operator=()

◆ predict()

◆ readBottle()

◆ reset()

◆ setC()

◆ setCoDomainSize()

◆ setDomainSize()

◆ train()

◆ writeBottle()