This dummy machine learner demonstrates how the IMachineLearner interface can be used in practice. More...

#include <DummyLearner.h>

Inheritance diagram for iCub::learningmachine::DummyLearner:

Public Member Functions
	DummyLearner (unsigned int dom=1, unsigned int cod=1)
	Constructor.

virtual	~DummyLearner ()
	Destructor (empty).

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.

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

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

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

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

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).

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

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

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

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

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.

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 dummy machine learner demonstrates how the IMachineLearner interface can be used in practice.

The functionality, however, is rather useless.

See also: iCub::contrib::IMachineLearner

Author: Arjan Gijsberts

Definition at line 44 of file DummyLearner.h.

Constructor & Destructor Documentation

◆ DummyLearner()

iCub::learningmachine::DummyLearner::DummyLearner	(	unsigned int	dom = `1`,
		unsigned int	cod = `1`
	)

inline

Constructor.

Definition at line 71 of file DummyLearner.h.

◆ ~DummyLearner()

virtual iCub::learningmachine::DummyLearner::~DummyLearner ( )

inlinevirtual

Destructor (empty).

Definition at line 82 of file DummyLearner.h.

Member Function Documentation

◆ clone()

DummyLearner * iCub::learningmachine::DummyLearner::clone ( )

inlinevirtual

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 107 of file DummyLearner.h.

◆ feedSample()

void iCub::learningmachine::DummyLearner::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 41 of file DummyLearner.cpp.

◆ getInfo()

std::string iCub::learningmachine::DummyLearner::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 74 of file DummyLearner.cpp.

◆ predict()

Prediction iCub::learningmachine::DummyLearner::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 56 of file DummyLearner.cpp.

◆ readBottle()

void iCub::learningmachine::DummyLearner::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 89 of file DummyLearner.cpp.

◆ reset()

void iCub::learningmachine::DummyLearner::reset ( )

virtual

Forget everything and start over.

Implements iCub::learningmachine::IMachineLearner.

Definition at line 67 of file DummyLearner.cpp.

◆ train()

void iCub::learningmachine::DummyLearner::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 51 of file DummyLearner.cpp.

◆ writeBottle()

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

virtual

Writes a serialization of the machine into a bottle.

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

Parameters

bot	the bottle containing the machine serialization

Reimplemented from iCub::learningmachine::IFixedSizeLearner.

Definition at line 83 of file DummyLearner.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DummyLearner()

◆ ~DummyLearner()

Member Function Documentation

◆ clone()

◆ feedSample()

◆ getInfo()

◆ predict()

◆ readBottle()

◆ reset()

◆ train()

◆ writeBottle()