JMATH::JQuantile_t Struct Reference

Auxiliary data structure for average. More...

#include <JQuantile_t.hh>

Public Member Functions
	JQuantile_t ()
	Default constructor. More...
void	reset ()
	Reset. More...
void	put (const double x)
	Put value. More...
long double	getMean () const
	Get mean value. More...
long double	getMean (const double value) const
	Get mean value. More...

Private Attributes
long double	total
long long int	count

Detailed Description

Auxiliary data structure for average.

The determination of the average should be independent of the order of the input values.

Definition at line 21 of file JQuantile_t.hh.

Constructor & Destructor Documentation

JMATH::JQuantile_t::JQuantile_t ( )

inline

Default constructor.

Definition at line 25 of file JQuantile_t.hh.

    {
      reset();
    }

Member Function Documentation

void JMATH::JQuantile_t::reset ( )

inline

Reset.

Definition at line 34 of file JQuantile_t.hh.

    {
      total = 0.0;
      count = 0;
    }

void JMATH::JQuantile_t::put ( const double  x )

inline

Put value.

Parameters

x

value

Definition at line 46 of file JQuantile_t.hh.

    {
      total += x;
      count += 1;
    }

long double JMATH::JQuantile_t::getMean ( ) const

inline

Get mean value.

Returns

mean value

Definition at line 58 of file JQuantile_t.hh.

    {
      if (count != 0.0)
        return total / count;
      else
        THROW(JDivisionByZero, "JQuantile_t::getMean()");
    }

long double JMATH::JQuantile_t::getMean ( const double  value ) const

inline

Get mean value.

Parameters

value

default value

Returns

mean value

Definition at line 73 of file JQuantile_t.hh.

    {
      if (count != 0.0)
        return getMean();
      else
        return value;
    }

Member Data Documentation

long double JMATH::JQuantile_t::total

private

Definition at line 82 of file JQuantile_t.hh.

long long int JMATH::JQuantile_t::count

private

Definition at line 83 of file JQuantile_t.hh.

---

The documentation for this struct was generated from the following file:

• JQuantile_t.hh