Jpp  18.6.0-rc.1
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
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.

26  {
27  reset();
28  }
void reset()
Reset.
Definition: JQuantile_t.hh:34

Member Function Documentation

void JMATH::JQuantile_t::reset ( )
inline

Reset.

Definition at line 34 of file JQuantile_t.hh.

35  {
36  total = 0.0;
37  count = 0;
38  }
long long int count
Definition: JQuantile_t.hh:83
long double total
Definition: JQuantile_t.hh:82
void JMATH::JQuantile_t::put ( const double  x)
inline

Put value.

Parameters
xvalue

Definition at line 46 of file JQuantile_t.hh.

47  {
48  total += x;
49  count += 1;
50  }
long long int count
Definition: JQuantile_t.hh:83
long double total
Definition: JQuantile_t.hh:82
long double JMATH::JQuantile_t::getMean ( ) const
inline

Get mean value.

Returns
mean value

Definition at line 58 of file JQuantile_t.hh.

59  {
60  if (count != 0.0)
61  return total / count;
62  else
63  THROW(JDivisionByZero, "JQuantile_t::getMean()");
64  }
long long int count
Definition: JQuantile_t.hh:83
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
long double total
Definition: JQuantile_t.hh:82
long double JMATH::JQuantile_t::getMean ( const double  value) const
inline

Get mean value.

Parameters
valuedefault value
Returns
mean value

Definition at line 73 of file JQuantile_t.hh.

74  {
75  if (count != 0.0)
76  return getMean();
77  else
78  return value;
79  }
long long int count
Definition: JQuantile_t.hh:83
long double getMean() const
Get mean value.
Definition: JQuantile_t.hh:58

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: