IMachineLearner.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2011 RobotCub Consortium, European Commission FP6 Project IST-004370
 * author:  Arjan Gijsberts
 * email:   arjan.gijsberts@iit.it
 * website: www.robotcub.org
 * Permission is granted to copy, distribute, and/or modify this program
 * under the terms of the GNU General Public License, version 2 or any
 * later version published by the Free Software Foundation.
 *
 * A copy of the license can be found at
 * http://www.robotcub.org/icub/license/gpl.txt
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 * Public License for more details
 */
 
#ifndef LM_IMACHINELEARNER__
#define LM_IMACHINELEARNER__
 
#include <string>
#include <sstream>
 
#include <yarp/sig/Vector.h>
#include <yarp/os/Portable.h>
#include <yarp/os/Bottle.h>
#include <yarp/os/Value.h>
 
#include "iCub/learningMachine/Prediction.h"
 
namespace iCub {
namespace learningmachine {
 
class IMachineLearner : public yarp::os::Portable {
protected:
    std::string name;
 
    virtual void writeBottle(yarp::os::Bottle& bot) const = 0;
 
    virtual void readBottle(yarp::os::Bottle& bot) = 0;
 
public:
    IMachineLearner() : name("") { }
 
    virtual ~IMachineLearner() { }
 
 
    virtual bool open(yarp::os::Searchable& config) {return true;}
 
    virtual bool close() {return true;}
 
    virtual bool configure(yarp::os::Searchable& config) {return false;}
 
    virtual void feedSample(const yarp::sig::Vector& input, const yarp::sig::Vector& output) = 0;
 
    virtual void train() { }
 
    virtual Prediction predict(const yarp::sig::Vector& input) = 0;
 
    virtual IMachineLearner* clone() = 0;
 
    virtual void reset() = 0;
 
    /*
     * Inherited from Portable.
     */
    bool write(yarp::os::ConnectionWriter& connection) const {
        yarp::os::Bottle model;
        this->writeBottle(model);
        return model.write(connection);
    }
 
    /*
     * Inherited from Portable.
     */
    bool read(yarp::os::ConnectionReader& connection) {
        yarp::os::Bottle model;
        model.read(connection);
        this->readBottle(model);
        return true;
    }
 
    virtual std::string getInfo() {
        return std::string("Type: ") + this->getName() + std::string("\n");
    }
 
    virtual std::string getConfigHelp() {
        return std::string("Machine configuration options for '") +
               this->getName() + "'\n";
    }
 
    virtual std::string toString() {
        yarp::os::Bottle model;
        this->writeBottle(model);
        return model.toString().c_str();
    }
 
    virtual bool fromString(const std::string& str) {
        yarp::os::Bottle model(str.c_str());
        this->readBottle(model);
        return true;
    }
 
    std::string getName() const {
        return this->name;
    }
 
    void setName(const std::string& name) {
        this->name = name;
    }
};
 
} // learningmachine
} // iCub
 
#endif