JMATH::JAverage< JValue_t > Struct Template Reference

Auxiliary class to determine average of set of values. More...

#include <JMath.hh>

Public Member Functions
	JAverage ()
	Default constructor. More...
template<class T >
	JAverage (T __begin, T __end)
	Constructor. More...
void	reset ()
	Reset. More...
	operator JValue_t () const
	Type conversion operator. More...
void	put (const JValue_t &value, const double w=1.0)
	Put value. More...

Private Attributes
JValue_t	value
double	weight

Detailed Description

template<class JValue_t>
struct JMATH::JAverage< JValue_t >

Auxiliary class to determine average of set of values.

Definition at line 412 of file JMath.hh.

Constructor & Destructor Documentation

template<class JValue_t>

JMATH::JAverage< JValue_t >::JAverage ( )

inline

Default constructor.

Definition at line 416 of file JMath.hh.

               :
      value (getZero<JValue_t>()),
      weight(0.0)
    {}

template<class JValue_t>

template<class T >

JMATH::JAverage< JValue_t >::JAverage ( T  __begin, T  __end  )

inline

Constructor.

Parameters

__begin	begin of data
__end	end of data

Definition at line 429 of file JMath.hh.

                                 :
      value (getZero<JValue_t>()),
      weight(0.0)
    {
      for (T i = __begin; i != __end; ++i) {
        value  += (*i);
        weight += 1.0;
      }
    }

Member Function Documentation

template<class JValue_t>

void JMATH::JAverage< JValue_t >::reset ( )

inline

Reset.

Definition at line 443 of file JMath.hh.

    {
      this->value  = getZero<JValue_t>();
      this->weight = 0.0;
    }

template<class JValue_t>

JMATH::JAverage< JValue_t >::operator JValue_t ( ) const

inline

Type conversion operator.

Returns

value

Definition at line 455 of file JMath.hh.

    {
      if (weight != 0.0)
        return value * (1.0 / weight);
      else
        THROW(JDivisionByZero, "Invalid weight.");
    }

template<class JValue_t>

void JMATH::JAverage< JValue_t >::put ( const JValue_t &  value, const double  w = 1.0  )

inline

Put value.

Parameters

value	value
w	weight

Definition at line 470 of file JMath.hh.

    {
      this->value  += value;
      this->weight += w;
    }

Member Data Documentation

template<class JValue_t>

JValue_t JMATH::JAverage< JValue_t >::value

private

Definition at line 477 of file JMath.hh.

template<class JValue_t>

double JMATH::JAverage< JValue_t >::weight

private

Definition at line 478 of file JMath.hh.

---

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

• JMath.hh