ClusteringEngine.hpp
No OneTemporary
Actions

Subscribers

None

File Metadata

	#ifndef CLUSTERINGENGINE_HPP
	#define CLUSTERINGENGINE_HPP

	#include <Matrix2D.hpp>

	/*!
	* \brief The ClusteringEngine class is an abstract class providing an interface
	* to other classes implementing data clustering methods.
	*/
	class ClusteringEngine
	{
	public:
	/*!
	* \brief The possible exit codes for the cluster method.
	* 0 the clustering procedure converged, 1 the clustering
	* procedure succeeded without converging, 2 the clustering
	* failed.
	*/
	enum exit_codes {CONVERGENCE=0, SUCCESS, FAILURE, NCODE=3} ;

	public:
	/*!
	* \brief Destructor.
	*/
	virtual ~ClusteringEngine() ;

	/*!
	* \brief Runs the clustering.
	* \return an exit code indicating whether how the clustering
	* ended.
	*/
	virtual exit_codes cluster() = 0 ;

	} ;

	#endif // CLUSTERINGENGINE_HPP