JQuantile_t.hh

Go to the documentation of this file.

#ifndef __JMATH__JQUANTILE_T__
#define __JMATH__JQUANTILE_T__

#include "JLang/JException.hh"

/**
 * \author mdejong
 */
namespace JMATH {}
namespace JPP { using namespace JMATH; }

namespace JMATH {

  using JLANG::JDivisionByZero;

  /**
   * Auxiliary data structure for average.
   *
   * The determination of the average should be independent of the order of the input values. 
   */
  struct JQuantile_t {
    /**
     * Default constructor.
     */
    JQuantile_t()
    {
      reset();
    }


    /**
     * Reset.
     */
    void reset()
    {
      total = 0.0;
      count = 0;
    }


    /**
     * Put value.
     *
     * \param  x           value
     */
    void put(const double x)
    {
      total += x;
      count += 1;
    }


    /**
     * Get mean value.
     *
     * \return             mean value
     */
    long double getMean() const
    {
      if (count != 0.0)
        return total / count;
      else
        THROW(JDivisionByZero, "JQuantile_t::getMean()");
    }


    /**
     * Get mean value.
     *
     * \param  value       default value
     * \return             mean value
     */
    long double getMean(const double value) const
    {
      if (count != 0.0)
        return getMean();
      else
        return value;
    }

  private:
    long double   total;
    long long int count;
  };
}

#endif