utility::Sum< T > Class Template Reference

A simple value container only allowing += and copy assignment. More...

#include <utility.hpp>

Collaboration diagram for utility::Sum< T >:

Public Member Functions
constexpr	Sum (T const &value)
	Construct from an initial value. More...
constexpr	Sum ()
	Default construct.
constexpr	operator T const & () const
	Returns the current sum of values. More...
constexpr Sum &	operator+= (T const &value)
	Add a value to the sum. More...

Private Attributes
T	value
	The sum of values accumulated.

Detailed Description

template<typename T>
class utility::Sum< T >

A simple value container only allowing += and copy assignment.

Template Parameters

T	The value type

Constructor & Destructor Documentation

Sum()

template<typename T >

constexpr utility::Sum< T >::Sum ( T const &  value )

inlineexplicitconstexpr

Construct from an initial value.

Parameters

value

The initial value

Member Function Documentation

operator T const &()

template<typename T >

constexpr utility::Sum< T >::operator T const & ( ) const

inlineconstexpr

Returns the current sum of values.

Returns

The sum of values by const reference

operator+=()

template<typename T >

constexpr Sum& utility::Sum< T >::operator+= ( T const &  value )

inlineconstexpr

Add a value to the sum.

Parameters

value

The value to add to the current sum

Returns

A self reference

---

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

• src/utility.hpp