Aleph-w 3.0
A C++ Library for Data Structures and Algorithms
Loading...
Searching...
No Matches
Aleph::Stats< T > Struct Template Reference

Container for comprehensive statistical results. More...

#include <stat_utils.H>

Public Member Functions

bool is_valid () const noexcept
 Check if statistics are valid.
 
T range () const noexcept
 Get the range (max - min).
 

Public Attributes

size_t count = 0
 Number of elements.
 
T sum = T()
 Sum of all values.
 
T mean = T()
 Arithmetic mean.
 
T variance = T()
 Sample variance.
 
T stddev = T()
 Standard deviation.
 
T median = T()
 Median (50th percentile)
 
T min = T()
 Minimum value.
 
T max = T()
 Maximum value.
 
T q1 = T()
 First quartile (25th percentile)
 
T q3 = T()
 Third quartile (75th percentile)
 
T iqr = T()
 Interquartile range (Q3 - Q1)
 
T skewness = T()
 Skewness (asymmetry)
 
T kurtosis = T()
 Excess kurtosis (tailedness)
 
T coef_variation = T()
 Coefficient of variation (stddev/mean)
 

Detailed Description

template<typename T>
struct Aleph::Stats< T >

Container for comprehensive statistical results.

Holds all computed statistics from a dataset analysis. Use with compute_all_stats() for complete analysis.

Template Parameters
TNumeric type (float, double, etc.)

Definition at line 122 of file stat_utils.H.

Member Function Documentation

◆ is_valid()

template<typename T >
bool Aleph::Stats< T >::is_valid ( ) const
inlinenoexcept

Check if statistics are valid.

Returns
true if count > 0

Definition at line 143 of file stat_utils.H.

References Aleph::Stats< T >::count.

Referenced by TEST().

◆ range()

template<typename T >
T Aleph::Stats< T >::range ( ) const
inlinenoexcept

Get the range (max - min).

Returns
Range of values

Definition at line 149 of file stat_utils.H.

References Aleph::Stats< T >::max, and Aleph::Stats< T >::min.

Referenced by TEST().

Member Data Documentation

◆ coef_variation

template<typename T >
T Aleph::Stats< T >::coef_variation = T()

Coefficient of variation (stddev/mean)

Definition at line 137 of file stat_utils.H.

◆ count

template<typename T >
size_t Aleph::Stats< T >::count = 0

Number of elements.

Definition at line 124 of file stat_utils.H.

Referenced by Aleph::Stats< T >::is_valid(), and TEST().

◆ iqr

template<typename T >
T Aleph::Stats< T >::iqr = T()

Interquartile range (Q3 - Q1)

Definition at line 134 of file stat_utils.H.

◆ kurtosis

template<typename T >
T Aleph::Stats< T >::kurtosis = T()

Excess kurtosis (tailedness)

Definition at line 136 of file stat_utils.H.

◆ max

template<typename T >
T Aleph::Stats< T >::max = T()

Maximum value.

Definition at line 131 of file stat_utils.H.

Referenced by Aleph::Stats< T >::range(), and TEST().

◆ mean

template<typename T >
T Aleph::Stats< T >::mean = T()

Arithmetic mean.

Definition at line 126 of file stat_utils.H.

◆ median

template<typename T >
T Aleph::Stats< T >::median = T()

Median (50th percentile)

Definition at line 129 of file stat_utils.H.

◆ min

template<typename T >
T Aleph::Stats< T >::min = T()

Minimum value.

Definition at line 130 of file stat_utils.H.

Referenced by Aleph::Stats< T >::range(), and TEST().

◆ q1

template<typename T >
T Aleph::Stats< T >::q1 = T()

First quartile (25th percentile)

Definition at line 132 of file stat_utils.H.

◆ q3

template<typename T >
T Aleph::Stats< T >::q3 = T()

Third quartile (75th percentile)

Definition at line 133 of file stat_utils.H.

◆ skewness

template<typename T >
T Aleph::Stats< T >::skewness = T()

Skewness (asymmetry)

Definition at line 135 of file stat_utils.H.

◆ stddev

template<typename T >
T Aleph::Stats< T >::stddev = T()

Standard deviation.

Definition at line 128 of file stat_utils.H.

◆ sum

template<typename T >
T Aleph::Stats< T >::sum = T()

Sum of all values.

Definition at line 125 of file stat_utils.H.

Referenced by Aleph::compute_all_stats().

◆ variance

template<typename T >
T Aleph::Stats< T >::variance = T()

Sample variance.

Definition at line 127 of file stat_utils.H.


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