IIndexStats.hpp

#pragma once
 
#include "DM/config.hpp"
#include "DM/Handle.hpp"
#include "DM/ObjectBase.hpp"
 
DM_NAMESPACE_BEGIN
 
enum struct IndexType
{
  tiling,   ///< flat tiling structure
  quadtree, ///< quad- or octree structure (depending on index dimension)
  kdtree,   ///< kd-tree structure
  rtree,    ///< r-tree structure
  count
};
 
/// \brief Object representing statistical information an spatial index
class DM_API IIndexStats : public ObjectBase
{
public:
  virtual ~IIndexStats() {}
 
  /// get an object copy
  virtual IIndexStats* clone() const = 0;
 
  virtual int dimension() const = 0;      ///< get index dimension
  virtual IndexType type() const = 0;   ///< get index type
  virtual int depth() const = 0;          ///< get index depth
  virtual int sizeNode() const = 0;     ///< get number of nodes 
  virtual int sizeLeaf() const = 0;     ///< get number of leafs (nodes that contain geometry objects)
  virtual double tileSize() const = 0;    ///< get tile size (only relevant if type == IndexType::tiling)
  virtual long long objectsInLeafMin()    const = 0;
  virtual long long objectsInLeafMax()    const = 0;
  virtual double    objectsInLeafMean()   const = 0;
  virtual double    objectsInLeafStddev() const = 0;
};
 
typedef Handle< IIndexStats > IndexStatsHandle;
 
 
 
DM_NAMESPACE_END