base_algorithm.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Authors:     Alberto Pascual Montano (pascual@cnb.csic.es)
 *
 * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307  USA
 *
 *  All comments concerning this program package may be sent to the
 *  e-mail address 'xmipp@cnb.csic.es'
 ***************************************************************************/

//-----------------------------------------------------------------------------
// ClassificationAlgorithm.h
// Base class for all algorithms within Xmipp Library
//-----------------------------------------------------------------------------


#ifndef BASEALGORITHM_H
#define BASEALGORITHM_H

#include <iostream>

#include "training_set.h"
#include "data_set.h"

#include <core/xmipp_funcs.h>

//-----------------------------------------------------------------------------
template<class DSClass>
class ClassificationAlgorithm
{
public:

    typedef DSClass DS;
    typedef typename DS::TS TS;

    ClassificationAlgorithm(const std::string& _ID = ""): ID(_ID)
    {};

    virtual ~ClassificationAlgorithm()
    {};

    virtual void train(DS& _ds, const TS& _examples) const
        {};

    virtual void train(DS& _ds, TS& _examples) const
        {};

    virtual double test(const DS& _ds, const TS& _examples) const = 0;

    virtual void printSelf(std::ostream& _os) const
    {
        _os << "xmippBaseAlgo" << std::endl; // to identify it as an algorith
        _os << ID << std::endl;
    };

    virtual const std::string& setID() const
    {
        return ID;
    };

    virtual std::string& setID()
    {
        return ID;
    };


    void setListener(BaseListener* _listener)
    {
        listener = _listener;
    };

protected:
    std::string ID;// algorithm ID, an unique name to recognize the algorithm
    BaseListener* listener;   // Listener class

};

//-----------------------------------------------------------------------------
template<class DS>
std::ostream& operator << (std::ostream& _os, const ClassificationAlgorithm<DS>& _algo)
{
    _algo.printSelf(_os);
    return _os;
}
#endif//XMIPPBASEALGO_H