IAddInfoStatistics.hpp

#ifndef DM_IADDINFO_STATISTICS_HPP_INCLUDED
#define DM_IADDINFO_STATISTICS_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

#include "DM/config.hpp"
#include "DM/IAddInfo.hpp"

DM_NAMESPACE_BEGIN

/// \brief stores a statistics about a set of addinfo objects.
/** 
  The statistic objects provides information about the minimum and maximum value, as well as, 
  the nummber of values that have been aggregated for each addinfo column. the minimum and maximum
  values can be accesed through two addinfo objects. It is secured that the minimum and maximum objects
  and the internal count vector are aligned (same AddInfoLayout)
*/
class DM_API IAddInfoStatistics : public ObjectBase
{
protected:
  virtual ~IAddInfoStatistics() {}

public:
  //IAddInfoStatistics Interface ==================================================
  virtual bool empty() const = 0;

  /// number of columns that are stored in the object 
  virtual unsigned columns() const = 0;

  /// access the layout of the attributs 
  virtual const IAddInfoLayout& layout() const = 0;

  /// addinfo object containing all minimum values
  virtual const IAddInfo& (min)() const = 0;
  /// addinfo object containing all maximum values
  virtual const IAddInfo& (max)() const = 0;

  /// get the count of values the were collected for the corresponding column 
  virtual int64_t count(unsigned col) const = 0;

  /// get the mean of values the were collected for the corresponding column 
  virtual double mean(unsigned col) const = 0;
  /// get the sigma of values the were collected for the corresponding column 
  virtual double sigma(unsigned col) const = 0;

  virtual void merge( const IAddInfoStatistics &other ) = 0;
};

typedef Handle<IAddInfoStatistics> AddInfoStatisticsHandle;

DM_NAMESPACE_END

#endif //DM_IADDINFO_STATISTICS_HPP_INCLUDED