sci_rs/lib.rs
1//! Embeddable Digital Signal Processing
2//!
3//! `sci_rs` is a collection of pure Rust implementations of
4//! useful statistical and filtering constructs.
5//!
6//! The goal for `sci_rs` is to provide f32 and f64 generic routines
7//! for processing real data with the same code used in research
8//! and deployment. We want predictable behavior on various compute tiers.
9//!
10//! Where analogous, interfaces will try to mirror scipy and numpy so
11//! that exploratory analysis is performed by the same code that runs in
12//! production.
13//!
14//! Where allocation is not necessary, this crate will support algorithms
15//! that do not require runtime allocation. `alloc` is a default feature
16//! that is required to compile in some algorithms.
17//!
18
19#![allow(unused)]
20#![cfg_attr(not(feature = "std"), no_std)]
21#![deny(missing_docs)]
22
23#[cfg(feature = "alloc")]
24extern crate alloc;
25
26/// Re-export nalgebra for convenience and to avoid version conflicts
27pub use nalgebra as na;
28
29/// Linear algebra
30pub mod linalg;
31
32/// Digital signal processing
33pub mod signal;
34
35/// Statistics
36pub mod stats;
37
38/// Special math functions
39pub mod special;
40
41/// Debug plotting
42#[cfg(feature = "plot")]
43pub mod plot;