IClassificationMatrix.hpp

#pragma once
 
 
#include "DM/config.hpp"
#include "DM/Handle.hpp"
#include "DM/ObjectBase.hpp"
#include "DM/Iterator.hpp"
 
DM_NAMESPACE_BEGIN
 
/// \brief Element of a cross classification matrix
class DM_API IClassificationElement : public ObjectBase
{
protected:
  virtual ~IClassificationElement() {}
 
public:
  virtual int     trueId()      const = 0;  ///< true class id
  virtual int     estimatedId() const = 0;  ///< estimated class id 
  virtual int64_t counter()     const = 0;  ///< number of elements in this element
};
 
typedef Handle<IClassificationElement> ClassificationElementHandle;
 
/// \brief Object for storing a cross classification matrix
class DM_API IClassificationMatrix : public ObjectBase
{
public:
  static IClassificationMatrix* New();  //create a new object
 
  typedef ConstIterator< int >        const_iterator;   
 
protected:
  virtual ~IClassificationMatrix() {}
 
public:
  virtual bool  exist(int trueId, int estimatedId) const = 0;
  virtual const IClassificationElement& get(int trueId, int estimatedId) const = 0;
  virtual void  increase(int trueId, int estimatedId, int64_t inc = 1) = 0;
 
  virtual const_iterator beginIds() const = 0;
  virtual const_iterator endIds() const = 0;
};
 
typedef Handle<IClassificationMatrix> ClassificationMatrixHandle;
 
 
DM_NAMESPACE_END