Struct holochain::prelude::metrics::RunAvg

pub struct RunAvg(_, _);

Running average that prioritizes memory and cpu efficiency over strict accuracy. For metrics where we can’t afford the memory of tracking samples for every remote we might talk to, this running average is accurate enough and uses only 5 bytes of memory.

Implementations

impl RunAvg

pub fn push<V>(&mut self, v: V)where V: AsPrimitive<f32>,

Push a new data point onto the running average

pub fn push_n<V>(&mut self, v: V, count: u8)where V: AsPrimitive<f32>,

Push multiple entries (up to 255) of the same value onto the average

Methods from Deref<Target = f32>

pub const RADIX: u32 = 2u32

pub const MANTISSA_DIGITS: u32 = 24u32

pub const DIGITS: u32 = 6u32

pub const EPSILON: f32 = 1.1920929E-7f32

pub const MIN: f32 = -3.40282347E+38f32

pub const MIN_POSITIVE: f32 = 1.17549435E-38f32

pub const MAX: f32 = 3.40282347E+38f32

pub const MIN_EXP: i32 = -125i32

pub const MAX_EXP: i32 = 128i32

pub const MIN_10_EXP: i32 = -37i32

pub const MAX_10_EXP: i32 = 38i32

pub const NAN: f32 = NaNf32

pub const INFINITY: f32 = +Inff32

pub const NEG_INFINITY: f32 = -Inff32

pub fn total_cmp(&self, other: &f32) -> Ordering

Return the ordering between self and other.

Unlike the standard partial comparison between floating point numbers, this comparison always produces an ordering in accordance to the totalOrder predicate as defined in the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

• negative quiet NaN
• negative signaling NaN
• negative infinity
• negative numbers
• negative subnormal numbers
• negative zero
• positive zero
• positive subnormal numbers
• positive numbers
• positive infinity
• positive signaling NaN
• positive quiet NaN.

The ordering established by this function does not always agree with the PartialOrd and PartialEq implementations of f32. For example, they consider negative and positive zero equal, while total_cmp doesn’t.

The interpretation of the signaling NaN bit follows the definition in the IEEE 754 standard, which may not match the interpretation by some of the older, non-conformant (e.g. MIPS) hardware implementations.

Example

struct GoodBoy {
    name: String,
    weight: f32,
}

let mut bois = vec![
    GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
    GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
    GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
    GoodBoy { name: "Chonk".to_owned(), weight: f32::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f32::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));

Trait Implementations

impl AsRef<f32> for RunAvg

fn as_ref(&self) -> &f32

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<f32> for RunAvg

fn borrow(&self) -> &f32

Immutably borrows from an owned value.

impl Clone for RunAvg

fn clone(&self) -> RunAvg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RunAvg

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

Formats the value using the given formatter.

impl Default for RunAvg

fn default() -> RunAvg

Returns the “default value” for a type.

impl Deref for RunAvg

type Target = f32

The resulting type after dereferencing.

fn deref(&self) -> &<RunAvg as Deref>::Target

Dereferences the value.

impl Display for RunAvg

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

Formats the value using the given formatter.

impl From<f32> for RunAvg

fn from(o: f32) -> RunAvg

Converts to this type from the input type.

impl From<f64> for RunAvg

fn from(o: f64) -> RunAvg

Converts to this type from the input type.

impl From<i16> for RunAvg

fn from(o: i16) -> RunAvg

Converts to this type from the input type.

impl From<i32> for RunAvg

fn from(o: i32) -> RunAvg

Converts to this type from the input type.

impl From<i64> for RunAvg

fn from(o: i64) -> RunAvg

Converts to this type from the input type.

impl From<i8> for RunAvg

fn from(o: i8) -> RunAvg

Converts to this type from the input type.

impl From<u16> for RunAvg

fn from(o: u16) -> RunAvg

Converts to this type from the input type.

impl From<u32> for RunAvg

fn from(o: u32) -> RunAvg

Converts to this type from the input type.

impl From<u64> for RunAvg

fn from(o: u64) -> RunAvg

Converts to this type from the input type.

impl From<u8> for RunAvg

fn from(o: u8) -> RunAvg

Converts to this type from the input type.

impl Copy for RunAvg