irox-stats 0.3.5

Various mathematical and statistics utilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

// SPDX-License-Identifier: MIT
// Copyright 2025 IROX Contributors
//

//!
//! A collection of digital signals processing and statistics functions

#![forbid(unsafe_code)]
#![warn(clippy::alloc_instead_of_core)]
#![warn(clippy::std_instead_of_alloc)]
#![warn(clippy::std_instead_of_core)]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(docsrs, feature(doc_cfg))]

extern crate alloc;
extern crate core;

use alloc::vec::Vec;

pub use gaussian as standard;

pub mod abg;
pub mod decay;
pub mod filter;
pub mod fitting;
pub mod gaussian;
pub mod lttb;
mod macros;
pub mod points;
pub mod pyramid;
pub mod rects;
pub mod sampling;
pub mod streaming;
pub mod streams;
#[cfg(any(all(doc, docsrs), all(feature = "std", feature = "miniz")))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "std", feature = "miniz"))))]
pub mod tsdf;
#[cfg(any(all(doc, docsrs), feature = "std"))]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub mod windows;

#[derive(Debug, Copy, Clone, PartialEq)]
pub enum DistributionParams {
    Mean(f64),
    StandardDeviation(f64),
    Variance(f64),
    Other(&'static str, f64),
}

/// This trait represents a statistical distribution
pub trait Distribution {
    /// computes the probability distribution function for a particular value
    fn pdf(&self, value: f64) -> f64;

    /// Returns a set of the known parameters of this distribution.
    fn get_params(&self) -> Vec<DistributionParams>;
}