Struct oxide_api::types::Histogramdouble

pub struct Histogramdouble {
    pub bins: Vec<Bindouble>,
    pub n_samples: u64,
    pub start_time: DisplayOptionDateTime,
}

A simple type for managing a histogram metric.

A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusive. There can’t be any “gaps” in the bins, and an additional bin may be added to the left, right, or both so that the bins extend to the entire range of the support.

Note that any gaps, unsorted bins, or non-finite values will result in an error.

Example —–– ```rust use oximeter::histogram::{BinRange, Histogram};

let edges = [0i64, 10, 20]; let mut hist = Histogram::new(&edges).unwrap(); assert_eq!(hist.n_bins(), 4); // One additional bin for the range (20..) assert_eq!(hist.n_samples(), 0); hist.sample(4); hist.sample(100); assert_eq!(hist.n_samples(), 2);

let data = hist.iter().collect::<Vec<_>>(); assert_eq!(data[0].range, BinRange::range(i64::MIN, 0)); // An additional bin for ..0 assert_eq!(data[0].count, 0); // Nothing is in this bin

assert_eq!(data[1].range, BinRange::range(0, 10)); // The range 0..10 assert_eq!(data[1].count, 1); // 4 is sampled into this bin ```

Notes —–

Histograms may be constructed either from their left bin edges, or from a sequence of ranges. In either case, the left-most bin may be converted upon construction. In particular, if the left-most value is not equal to the minimum of the support, a new bin will be added from the minimum to that provided value. If the left-most value is the support’s minimum, because the provided bin was unbounded below, such as (..0), then that bin will be converted into one bounded below, (MIN..0) in this case.

The short of this is that, most of the time, it shouldn’t matter. If one specifies the extremes of the support as their bins, be aware that the left-most may be converted from a BinRange::RangeTo into a BinRange::Range. In other words, the first bin of a histogram is always a Bin::Range or a Bin::RangeFrom after construction. In fact, every bin is one of those variants, the BinRange::RangeTo is only provided as a convenience during construction.

Fields

bins: Vec<Bindouble>

n_samples: u64

start_time: DisplayOptionDateTime

Trait Implementations

impl Clone for Histogramdouble

fn clone(&self) -> Histogramdouble

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Histogramdouble

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Histogramdouble

fn default() -> Histogramdouble

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Histogramdouble

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Histogramdouble

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<Histogramdouble> for Histogramdouble

fn eq(&self, other: &Histogramdouble) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Histogramdouble

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Tabled for Histogramdouble

const LENGTH: usize = 2usize

A length of fields and headers, which must be the same.

fn fields(&self) -> Vec<String>

Fields method must return a list of cells.

fn headers() -> Vec<String>

Headers must return a list of column names.

impl StructuralPartialEq for Histogramdouble