Jpp  18.5.2
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 76 of file JKatoomba_t.hh.

Constructor & Destructor Documentation

JACOUSTICS::JQuantile::JQuantile ( )
inline

Default constructor.

Definition at line 80 of file JKatoomba_t.hh.

81  {
82  reset();
83  }
void reset()
Reset.
Definition: JKatoomba_t.hh:89

Member Function Documentation

void JACOUSTICS::JQuantile::reset ( )
inline

Reset.

Definition at line 89 of file JKatoomba_t.hh.

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

Put value.

Parameters
xvalue

Definition at line 101 of file JKatoomba_t.hh.

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

Get mean value.

Returns
mean value

Definition at line 113 of file JKatoomba_t.hh.

114  {
115  if (count != 0.0)
116  return total / count;
117  else
118  THROW(JDivisionByZero, "JQuantile::getMean()");
119  }
long long int count
Definition: JKatoomba_t.hh:138
#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 128 of file JKatoomba_t.hh.

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

Member Data Documentation

long double JACOUSTICS::JQuantile::total
private

Definition at line 137 of file JKatoomba_t.hh.

long long int JACOUSTICS::JQuantile::count
private

Definition at line 138 of file JKatoomba_t.hh.


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