Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
statistics Class Reference

#include <utilities.h>

Public Member Functions

 statistics ()

Public Attributes

double min
double max
double total
double average

Detailed Description

A simple container for storing basic statistical values.

This class holds the minimum, maximum, total, and average values of a dataset. It is initialized with zeros by default. This small class allows us to agglomerate the statistics instead of returning tuples. For example, this class is used to store the kinetic energy of the particles in the DEM model.

Definition at line 55 of file utilities.h.

Constructor & Destructor Documentation

◆ statistics()

statistics::statistics ( )
inline

Default constructor.

Initializes all statistical values (min, max, total, average) to 0.

Definition at line 63 of file utilities.h.

References average, max, min, and total.

Member Data Documentation

◆ average

double statistics::average

The average value of the dataset.

Definition at line 81 of file utilities.h.

◆ max

double statistics::max

The maximum value in the dataset.

Definition at line 75 of file utilities.h.

◆ min

double statistics::min

The minimum value in the dataset.

Definition at line 72 of file utilities.h.

◆ total

double statistics::total

The sum of all values in the dataset.

Definition at line 78 of file utilities.h.


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