Ion
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
ion::analytics::IntervalDiscrepancy Struct Reference

Result of a discrepancy computation, including the value measured and the bounds of the interval where that value was measured. More...

#include "discrepancy.h"

Collaboration diagram for ion::analytics::IntervalDiscrepancy:
Collaboration graph
[legend]

Public Member Functions

 IntervalDiscrepancy ()
 Default constructor, initializing all values to zero. More...
 
 IntervalDiscrepancy (double discrepancy, double begin, double end, size_t num_samples)
 Constructor. More...
 

Public Attributes

double discrepancy
 The discrepancy of the samples in the interval. More...
 
double begin
 The beginning of the interval where the value was measured. More...
 
double end
 The end of the interval where the value was measured. More...
 
size_t num_samples
 The number of samples in the interval from begin to end. More...
 

Detailed Description

Result of a discrepancy computation, including the value measured and the bounds of the interval where that value was measured.

Used to diagnose edge cases where the value alone provides insufficient information.

Definition at line 128 of file discrepancy.h.

Constructor & Destructor Documentation

ion::analytics::IntervalDiscrepancy::IntervalDiscrepancy ( )
inline

Default constructor, initializing all values to zero.

Definition at line 130 of file discrepancy.h.

ion::analytics::IntervalDiscrepancy::IntervalDiscrepancy ( double  discrepancy,
double  begin,
double  end,
size_t  num_samples 
)
inline

Constructor.

Definition at line 133 of file discrepancy.h.

Member Data Documentation

double ion::analytics::IntervalDiscrepancy::begin

The beginning of the interval where the value was measured.

Definition at line 142 of file discrepancy.h.

Referenced by ion::analytics::AbsoluteTimestampDiscrepancy().

double ion::analytics::IntervalDiscrepancy::discrepancy

The discrepancy of the samples in the interval.

Definition at line 140 of file discrepancy.h.

Referenced by ion::analytics::AbsoluteTimestampDiscrepancy(), and ion::analytics::Discrepancy().

double ion::analytics::IntervalDiscrepancy::end

The end of the interval where the value was measured.

Definition at line 144 of file discrepancy.h.

Referenced by ion::analytics::AbsoluteTimestampDiscrepancy().

size_t ion::analytics::IntervalDiscrepancy::num_samples

The number of samples in the interval from begin to end.

The interval might be open or closed. Discrepancy checks both cases and reports the worst case.

Definition at line 148 of file discrepancy.h.

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