Stats< ValueT, 0 > Class Template Reference

This class computes statistics (minimum value, maximum value, mean, variance and standard deviation) of a population of floating-point values. More...

#include <nanovdb/util/GridStats.h>

Inherits Extrema< ValueT, 0 >.

Public Types
using	ValueType = ValueT

Public Member Functions
__hostdev__	Stats ()
__hostdev__	Stats (const ValueT &val)
__hostdev__ Stats &	add (const ValueT &val)
	Add a single sample. More...
__hostdev__ Stats &	add (const ValueT &val, uint64_t n)
	Add n samples with constant value val. More...
__hostdev__ Stats &	add (const Stats &other)
	Add the samples from the other Stats instance. More...
__hostdev__ size_t	size () const
template<typename NodeT >
__hostdev__ void	setStats (NodeT &node) const
__hostdev__ Extrema &	min (const ValueT &v)
__hostdev__ const ValueT &	min () const
__hostdev__ Extrema &	max (const ValueT &v)
__hostdev__ const ValueT &	max () const
__hostdev__ Extrema &	add (const Extrema &other)
__hostdev__	operator bool () const
__hostdev__ double	avg () const
	Return the arithmetic mean, i.e. average, value. More...
__hostdev__ double	mean () const
	Return the arithmetic mean, i.e. average, value. More...
__hostdev__ double	var () const
	Return the population variance. More...
__hostdev__ double	variance () const
	Return the population variance. More...
__hostdev__ double	std () const
	Return the standard deviation (=Sqrt(variance)) as defined from the (biased) population variance. More...
__hostdev__ double	stdDev () const
	Return the standard deviation (=Sqrt(variance)) as defined from the (biased) population variance. More...

Static Public Member Functions
static __hostdev__ constexpr bool	hasMinMax ()
static __hostdev__ constexpr bool	hasAverage ()
static __hostdev__ constexpr bool	hasStdDeviation ()
static __hostdev__ constexpr bool	hasStats ()
static __hostdev__ constexpr size_t	size ()

Protected Types
using	BaseT = Extrema< ValueT, 0 >
using	RealT = double

Protected Attributes
size_t	mSize
double	mAvg
double	mAux
ValueT	mMin
ValueT	mMax

Detailed Description

template<typename ValueT>
class nanovdb::Stats< ValueT, 0 >

This class computes statistics (minimum value, maximum value, mean, variance and standard deviation) of a population of floating-point values.

variance = Mean[ (X-Mean[X])^2 ] = Mean[X^2] - Mean[X]^2, standard deviation = sqrt(variance)

Note

This class employs incremental computation and double precision.

Member Typedef Documentation

using BaseT = Extrema<ValueT, 0>

protected

using RealT = double

protected

using ValueType = ValueT

Constructor & Destructor Documentation

__hostdev__ Stats ( )

inline

__hostdev__ Stats ( const ValueT &  val )

inline

Member Function Documentation

__hostdev__ Extrema& add ( const Extrema< ValueT, 0 > &  other )

inlineinherited

__hostdev__ Stats& add ( const ValueT &  val )

inline

Add a single sample.

__hostdev__ Stats& add ( const ValueT &  val, uint64_t  n  )

inline

Add n samples with constant value val.

__hostdev__ Stats& add ( const Stats< ValueT, 0 > &  other )

inline

Add the samples from the other Stats instance.

__hostdev__ double avg ( ) const

inline

Return the arithmetic mean, i.e. average, value.

static __hostdev__ constexpr bool hasAverage ( )

inlinestatic

static __hostdev__ constexpr bool hasMinMax ( )

inlinestatic

static __hostdev__ constexpr bool hasStats ( )

inlinestatic

static __hostdev__ constexpr bool hasStdDeviation ( )

inlinestatic

__hostdev__ Extrema& max ( const ValueT &  v )

inlineinherited

__hostdev__ const ValueT& max ( ) const

inlineinherited

__hostdev__ double mean ( ) const

inline

Return the arithmetic mean, i.e. average, value.

__hostdev__ Extrema& min ( const ValueT &  v )

inlineinherited

__hostdev__ const ValueT& min ( ) const

inlineinherited

__hostdev__ operator bool ( ) const

inlineinherited

__hostdev__ void setStats ( NodeT &  node ) const

inline

static __hostdev__ constexpr size_t size ( )

inlinestaticinherited

__hostdev__ size_t size ( ) const

inline

__hostdev__ double std ( ) const

inline

Return the standard deviation (=Sqrt(variance)) as defined from the (biased) population variance.

__hostdev__ double stdDev ( ) const

inline

Return the standard deviation (=Sqrt(variance)) as defined from the (biased) population variance.

__hostdev__ double var ( ) const

inline

Return the population variance.

Note

The unbiased sample variance = population variance * num/(num-1)

__hostdev__ double variance ( ) const

inline

Return the population variance.

Note

The unbiased sample variance = population variance * num/(num-1)

Member Data Documentation

double mAux

protected

double mAvg

protected

ValueT mMax

protectedinherited

ValueT mMin

protectedinherited

size_t mSize

protected