rapidsmpf::Statistics::Stat Class Reference

Represents a single tracked statistic. More...

#include <statistics.hpp>

Public Member Functions
	Stat ()=default
	Default-constructs a Stat.
auto	operator<=> (Stat const &) const noexcept=default
	Three-way comparison operator. More...
void	add (double value)
	Adds a value to this statistic. More...
std::size_t	count () const noexcept
	Returns the number of updates applied to this statistic. More...
double	value () const noexcept
	Returns the total accumulated value. More...
double	max () const noexcept
	Returns the maximum value seen across all add() calls. More...

Detailed Description

Represents a single tracked statistic.

Definition at line 201 of file statistics.hpp.

Member Function Documentation

add()

void rapidsmpf::Statistics::Stat::add ( double  value )

inline

Adds a value to this statistic.

Parameters

value

The value to add.

Definition at line 222 of file statistics.hpp.

count()

std::size_t rapidsmpf::Statistics::Stat::count ( ) const

inlinenoexcept

Returns the number of updates applied to this statistic.

Returns

The number of times add() was called.

Definition at line 233 of file statistics.hpp.

max()

double rapidsmpf::Statistics::Stat::max ( ) const

inlinenoexcept

Returns the maximum value seen across all add() calls.

Returns

The maximum value added, or negative infinity if add() was never called.

Definition at line 252 of file statistics.hpp.

operator<=>()

auto rapidsmpf::Statistics::Stat::operator<=> ( Stat const &  ) const

defaultnoexcept

Three-way comparison operator.

Performs memberwise comparison of all data members.

Returns

The ordering result of the memberwise comparison.

value()

double rapidsmpf::Statistics::Stat::value ( ) const

inlinenoexcept

Returns the total accumulated value.

Returns

The sum of all values added.

Definition at line 242 of file statistics.hpp.

---

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

• /__w/rapidsmpf/rapidsmpf/cpp/include/rapidsmpf/statistics.hpp