allan 0.2.1

variance and deviation tools for stability analysis

Crate allan [] [src]

Allan provides variance and deviation tools for stability analysis

Goals

  • provide streaming variance and deviations from series data
  • pre-allocated datastructures

Usage

Create a new instance, add records, retrieve statistic

Example

Create a new instance, add a few records, retrieve allan deviation


use allan::*;

// a default Allan
let mut allan = Allan::new();
for _ in 0..100 {
    allan.record(1.0);
}
assert_eq!(allan.get(1).unwrap().deviation().unwrap(), 0.0);

// a configured Allan
let mut allan = Allan::configure().max_tau(10_000).build().unwrap();

Structs

Allan

the main datastructure for Allan

Config

used to configure an Allan

Tau

a duration-based bucket for the stability metric

Enums

Style

describes the gaps between Tau and impacts space and computational costs