sliding_features 8.0.0

Modular sliding window with various signal processing functions and technical indicators
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

#![deny(
    missing_docs,
    rustdoc::missing_crate_level_docs,
    unused_crate_dependencies
)]
#![warn(clippy::all)]
#![doc = include_str!("../README.md")]

//! The sliding_features crate provides modular, chainable sliding windows
//! for various signal processing function and technical indicators

pub mod pure_functions;
pub mod rolling;
pub mod sliding_windows;

#[cfg(test)]
mod plot;
#[cfg(test)]
mod test_data;

/// The most important Trait, defining methods which each sliding feature needs to implement
pub trait View<T: num::Float> {
    /// Update the state with a new value
    fn update(&mut self, val: T);

    /// Return the last value, if `Some`, then its ready.
    fn last(&self) -> Option<T>;
}

#[cfg(test)]
mod tests {
    // Used in benchmarks.
    #[allow(unused_imports)]
    use criterion::*;
}