Average.h

Go to the documentation of this file.

#ifndef PMPL_AVERAGE_H_
#define PMPL_AVERAGE_H_
 
#include <cstddef>
 
 
template <typename T>
class Average final
{
 
 
  size_t m_count{0}; 
  T m_total{T()};    
 
 
  public:
 
 
    Average& operator+=(const T& _value) noexcept;
 
    Average& AddSummedValues(const T& _sum, const size_t _count) noexcept;
 
 
    T Get() const noexcept;
 
    const T& Sum() const noexcept;
 
    size_t Count() const noexcept;
 
 
};
 
/*-------------------------------- Modifiers ---------------------------------*/
 
template <typename T>
inline
Average<T>&
Average<T>::
operator+=(const T& _value) noexcept {
  m_total += _value;
  ++m_count;
  return *this;
}
 
 
template <typename T>
inline
Average<T>&
Average<T>::
AddSummedValues(const T& _sum, const size_t _count) noexcept {
  m_total += _sum;
  m_count += _count;
  return *this;
}
 
/*--------------------------------- Queries ----------------------------------*/
 
template <typename T>
inline
T
Average<T>::
Get() const noexcept {
  return m_total / m_count;
}
 
 
template <typename T>
inline
const T&
Average<T>::
Sum() const noexcept {
  return m_total;
}
 
 
template <typename T>
inline
size_t
Average<T>::
Count() const noexcept {
  return m_count;
}
 
/*----------------------------------------------------------------------------*/
 
#endif