Public Member Functions | List of all members
error_cache_element Class Reference

#include <error_summary.h>

Public Member Functions

 error_cache_element ()
 
void update_error (const float error_rate)
 
void update_cycle (const size_t cycle_within_read)
 
float average () const
 
size_t max_cycle () const
 
bool is_empty () const
 

Detailed Description

Cache data structure for error metrics

Constructor & Destructor Documentation

error_cache_element ( )
inline

Constructor

Member Function Documentation

float average ( ) const
inline

Average error rate

Returns
average
bool is_empty ( ) const
inline

Test if there are no error values

Returns
true if no values have been averaged
size_t max_cycle ( ) const
inline

Get the maximum cycle apart of the average

Returns
maximum cycle
void update_cycle ( const size_t  cycle_within_read)
inline

Update the cache element

Parameters
cycle_within_readcycle within read
void update_error ( const float  error_rate)
inline

Update the cache element

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