Statistic.h

 
#pragma once

 
#if defined(Statistics_RECURSES)
#error Recursive header files inclusion detected in Statistics.h
#else // defined(Statistics_RECURSES)
#define Statistics_RECURSES
 
#if !defined Statistics_h
#define Statistics_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/CCommutativeRing.h"
#include "DGtal/kernel/NumberTraits.h"
#include <utility>
#include <vector>
 
namespace DGtal
{
  template <typename TQuantity>
  class Statistic
  {
 
    // ----------------------- public types -----------------------------------
  public:
    typedef TQuantity Quantity;
    BOOST_CONCEPT_ASSERT(( concepts::CCommutativeRing<Quantity> ) );
    typedef std::vector< Quantity > Container;
    typedef typename Container::const_iterator ConstIterator;
 
    // ----------------------- Standard services ------------------------------
  public:

    ~Statistic();

    Statistic(bool storeSample=false);

    Statistic( const Statistic & other );

    Statistic & operator=( const Statistic & other );

    Statistic & operator+=( const Statistic & other );

    Statistic operator+( const Statistic & other ) const;

    ConstIterator begin() const;

    ConstIterator end() const;
 
    // ----------------------- Accessors ------------------------------
  public:
 

    unsigned int samples() const;

    unsigned int size() const;

    double mean() const;

    double variance() const;

    double unbiasedVariance() const;

    Quantity max() const;

    Quantity min() const;
 

    Quantity median();

    Quantity operator[]( unsigned int i ) const;

    void addValue( Quantity v );

    template <class Iter>
    void addValues( Iter b, Iter e );

    void clear();

    void terminate();
 
 
 
    // ----------------------- Interface --------------------------------------
  public:

    void selfDisplay( std::ostream & that_stream ) const;

    bool OK() const;
 
 
    // ------------------------- Data ----------------------------------------
  private:
 
 
    // ------------------------- Data ----------------------------------------
  private:

    unsigned int mySamples;

    Quantity myExp;

    Quantity myExp2;

    Quantity myMax;

    Quantity myMin;
 

    Quantity myMedian;
 

    Container myValues;
 

    bool myStoreSamples;
 

    bool myIsTerminated;
 
  };

  template <typename TQuantity>
  std::ostream&
  operator<<( std::ostream & thatStream,
        const Statistic<TQuantity> & that_object_to_display );
 
 
} // namespace DGtal
 

// Includes inline functions/methods if necessary.
#include "DGtal/math/Statistic.ih"
 
//                                                                           //
 
#endif // !defined Statistic_h
 
#undef Statistic_RECURSES
#endif // else defined(Statistic_RECURSES)