Jpp  18.2.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
JACOUSTICS::JQuantile Struct Reference

Auxiliary data structure for average. More...

#include <JKatoomba_t.hh>

Public Member Functions

 JQuantile ()
 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.

Definition at line 75 of file JKatoomba_t.hh.

Constructor & Destructor Documentation

JACOUSTICS::JQuantile::JQuantile ( )
inline

Default constructor.

Definition at line 79 of file JKatoomba_t.hh.

80  {
81  reset();
82  }
void reset()
Reset.
Definition: JKatoomba_t.hh:88

Member Function Documentation

void JACOUSTICS::JQuantile::reset ( )
inline

Reset.

Definition at line 88 of file JKatoomba_t.hh.

89  {
90  total = 0.0;
91  count = 0;
92  }
long long int count
Definition: JKatoomba_t.hh:137
void JACOUSTICS::JQuantile::put ( const double  x)
inline

Put value.

Parameters
xvalue

Definition at line 100 of file JKatoomba_t.hh.

101  {
102  total += x;
103  count += 1;
104  }
long long int count
Definition: JKatoomba_t.hh:137
long double JACOUSTICS::JQuantile::getMean ( ) const
inline

Get mean value.

Returns
mean value

Definition at line 112 of file JKatoomba_t.hh.

113  {
114  if (count != 0.0)
115  return total / count;
116  else
117  THROW(JDivisionByZero, "JQuantile::getMean()");
118  }
long long int count
Definition: JKatoomba_t.hh:137
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
Exception for division by zero.
Definition: JException.hh:286
long double JACOUSTICS::JQuantile::getMean ( const double  value) const
inline

Get mean value.

Parameters
valuedefault value
Returns
mean value

Definition at line 127 of file JKatoomba_t.hh.

128  {
129  if (count != 0.0)
130  return getMean();
131  else
132  return value;
133  }
long long int count
Definition: JKatoomba_t.hh:137
long double getMean() const
Get mean value.
Definition: JKatoomba_t.hh:112

Member Data Documentation

long double JACOUSTICS::JQuantile::total
private

Definition at line 136 of file JKatoomba_t.hh.

long long int JACOUSTICS::JQuantile::count
private

Definition at line 137 of file JKatoomba_t.hh.


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