cute-dsp 0.0.40

A Rust library for audio and signal processing
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

//! Common definitions and helper functions used by the rest of the library

#![allow(unused_imports)]

#[cfg(feature = "std")]
use std::f32::consts::PI;

#[cfg(not(feature = "std"))]
use core::f32::consts::PI;

/// The version of the library
pub const VERSION_MAJOR: u32 = 1;
pub const VERSION_MINOR: u32 = 6;
pub const VERSION_PATCH: u32 = 2;
pub const VERSION_STRING: &str = "1.6.2";

/// Check if the library version is compatible (semver).
/// Major versions are not compatible with each other.
/// Minor and patch versions are backwards-compatible.
#[inline]
pub const fn version_check(major: u32, minor: u32, patch: u32) -> bool {
    major == VERSION_MAJOR
        && (VERSION_MINOR > minor
            || (VERSION_MINOR == minor && VERSION_PATCH >= patch))
}

/// Macro to check the library version is compatible (semver).
#[macro_export]
macro_rules! version_check {
    ($major:expr, $minor:expr, $patch:expr) => {
        const _: bool = $crate::common::version_check($major, $minor, $patch);
    };
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_version_check() {
        assert!(version_check(1, 6, 2));
        assert!(version_check(1, 6, 1));
        assert!(version_check(1, 5, 0));
        assert!(!version_check(2, 0, 0));
        assert!(!version_check(1, 7, 0));
    }
}