IFixedSizeLearner.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_IFIXEDSIZELEARNER__
#define LM_IFIXEDSIZELEARNER__
 
#include "iCub/learningMachine/IMachineLearner.h"
 
 
namespace iCub {
namespace learningmachine {
 
class IFixedSizeLearner : public IMachineLearner {
protected:
    unsigned int domainSize;
 
    unsigned int coDomainSize;
 
    virtual bool checkDomainSize(const yarp::sig::Vector& input);
 
    virtual bool checkCoDomainSize(const yarp::sig::Vector& output);
 
    void validateDomainSizes(const yarp::sig::Vector& input, const yarp::sig::Vector& output);
 
    /*
     * Inherited from IMachineLearner.
     */
    virtual void writeBottle(yarp::os::Bottle& bot) const;
 
    /*
     * Inherited from IMachineLearner.
     */
    virtual void readBottle(yarp::os::Bottle& bot);
 
public:
    IFixedSizeLearner(unsigned int dom = 1, unsigned int cod = 1) : domainSize(dom), coDomainSize(cod) { }
 
    /*
     * Inherited from IMachineLearner.
     */
    virtual void feedSample(const yarp::sig::Vector& input, const yarp::sig::Vector& output);
 
    /*
     * Inherited from IMachineLearner.
     */
    virtual void train();
 
    unsigned int getDomainSize() const { return this->domainSize; }
 
    unsigned int getCoDomainSize() const { return this->coDomainSize; }
 
    virtual void setDomainSize(unsigned int size) { this->domainSize = size; }
 
    virtual void setCoDomainSize(unsigned int size) {this->coDomainSize = size; }
 
    /*
     * Inherited from IMachineLearner.
     */
    virtual std::string getInfo();
 
    /*
     * Inherited from IMachineLearner.
     */
    virtual std::string getConfigHelp();
 
    /*
     * Inherited from IMachineLearner.
     */
    virtual bool configure(yarp::os::Searchable& config);
 
};
 
} // learningmachine
} // iCub
 
#endif