russell_stat 2.0.0

Statistics calculations and (engineering) probability distributions
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

//! Russell - Rust Scientific Library
//!
//! `russell_stat`: Statistics calculations and (engineering) probability distributions
//!
//! **Important:** This crate depends on external libraries (non-Rust). Thus, please check the [Installation Instructions on the GitHub Repository](https://github.com/cpmech/russell).
//!
//! This library assists in developing statistical computations and simulations aiming at engineering applications, such as reliability analyses. This library provides a light interface to [rand_distr](https://crates.io/crates/rand_distr) and implements extra functionality.
//!
//! It also provides tools for descriptive statistics, including quantiles, inter-quartile range (IQR), and outlier detection, as well as a text-based histogram generator.
//!
//! Some essential distributions considered in this library are those classified as [Extreme Value Distribution](https://en.wikipedia.org/wiki/Generalized_extreme_value_distribution).

/// Defines the error output as a static string
pub type StrError = &'static str;

use rand::rngs::ThreadRng;

/// Returns the thread-local random number generator, seeded by the system
///
/// See more information here: [rand::rng()]
#[inline]
pub fn get_rng() -> ThreadRng {
    // re-exported for convenience
    rand::rng()
}

mod distribution_frechet;
mod distribution_gumbel;
mod distribution_lognormal;
mod distribution_normal;
mod distribution_uniform;
mod histogram;
mod inter_quartile_range;
mod outliers;
mod probability_distribution;
mod quantile;
mod quartiles;
mod statistics;

pub use distribution_frechet::*;
pub use distribution_gumbel::*;
pub use distribution_lognormal::*;
pub use distribution_normal::*;
pub use distribution_uniform::*;
pub use histogram::*;
pub use inter_quartile_range::*;
pub use outliers::*;
pub use probability_distribution::*;
pub use quantile::*;
pub use quartiles::*;
pub use statistics::*;

// run code from README file
#[doc = include_str!("../README.md")]
#[cfg(doctest)]
pub struct ReadmeDoctest;