ripple 0.2.1

General-purpose DSP data structures and algorithms
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

#![doc(html_logo_url = "https://raw.githubusercontent.com/limads/ripple/master/assets/ripple-logo.png")]

//! This crate offers a high-level API to for applications that require
//! multiresolution analysis algorithms.

pub(crate) mod foreign;

pub mod conv;

pub mod signal;

pub mod fft;

pub mod dwt;

pub(crate) fn panic_on_invalid_slices<A, B>(a : &[A], b : &[B]) {
    if a.len() == 0 {
        panic!("Input slice has zero lenght");
    }
    if b.len() == 0 {
        panic!("Output slice has zero lenght");
    }
    if a.len() != b.len() {
        panic!("Input and output slices differ in lenght ({} vs. {})", a.len(), b.len());
    }
}

#[cfg(feature="ipp")]
pub(crate) mod ipputils {

    use std::mem;
    use std::ptr;
    use std::ffi;
    use crate::foreign::ipp::ipps;
    use nalgebra::Scalar;
    use crate::foreign::ipp::ippcore::{self, ippMalloc};

    pub enum ScalarSlice<'a> {
        U8(&'a [u8]),
        I16(&'a [i16]),
        I32(&'a [i32]),
        F32(&'a [f32]),
        F64(&'a [f64])
    }

    impl<'a> From<&'a [u8]> for ScalarSlice<'a> {

        fn from(s : &'a [u8]) -> Self {
            ScalarSlice::U8(s)
        }

    }

    impl<'a> From<&'a [i16]> for ScalarSlice<'a> {

        fn from(s : &'a [i16]) -> Self {
            ScalarSlice::I16(s)
        }

    }

    impl<'a> From<&'a [i32]> for ScalarSlice<'a> {

        fn from(s : &'a [i32]) -> Self {
            ScalarSlice::I32(s)
        }

    }

    impl<'a> From<&'a [f32]> for ScalarSlice<'a> {

        fn from(s : &'a [f32]) -> Self {
            ScalarSlice::F32(s)
        }

    }

    impl<'a> From<&'a [f64]> for ScalarSlice<'a> {

        fn from(s : &'a [f64]) -> Self {
            ScalarSlice::F64(s)
        }

    }

    pub enum ScalarSliceMut<'a> {
        U8(&'a mut [u8]),
        I16(&'a mut [i16]),
        I32(&'a mut [i32]),
        F32(&'a mut [f32]),
        F64(&'a mut [f64])
    }

    impl<'a> From<&'a mut [u8]> for ScalarSliceMut<'a> {

        fn from(s : &'a mut [u8]) -> Self {
            ScalarSliceMut::U8(s)
        }

    }

    impl<'a> From<&'a mut [i16]> for ScalarSliceMut<'a> {

        fn from(s : &'a mut [i16]) -> Self {
            ScalarSliceMut::I16(s)
        }

    }

    impl<'a> From<&'a mut [i32]> for ScalarSliceMut<'a> {

        fn from(s : &'a mut [i32]) -> Self {
            ScalarSliceMut::I32(s)
        }

    }

    impl<'a> From<&'a mut [f32]> for ScalarSliceMut<'a> {

        fn from(s : &'a mut [f32]) -> Self {
            ScalarSliceMut::F32(s)
        }

    }

    impl<'a> From<&'a mut [f64]> for ScalarSliceMut<'a> {

        fn from(s : &'a mut [f64]) -> Self {
            ScalarSliceMut::F64(s)
        }

    }

    pub fn row_size_bytes<T>(ncol : usize) -> i32 {
        (ncol * mem::size_of::<T>()) as i32
    }

    pub fn check_status(action : &str, status : i32) {
        if status as u32 == ippcore::ippStsNoErr {
            return;
        }
        let err_msg : &'static str = match status {
            ippcore::ippStsNullPtrErr => "Null pointer",
            ippcore::ippStsNumChannelsErr => "Wrong number of channels",
            ippcore::ippStsAnchorErr => "Anchor error",
            ippcore::ippStsSizeErr => "Size error",
            ippcore::ippStsStepErr => "Step error",
            ippcore::ippStsContextMatchErr => "Context match error",
            ippcore::ippStsMemAllocErr => "Memory allocation error",
            ippcore::ippStsBadArgErr => "Bad argument",
            _ => "Unknown error"
        };
        panic!("IPPS Error\tAction: {}\tCode: {}\tMessage: {}", action, status, err_msg);
    }

    pub fn slice_size_bytes<T>(s : &[T]) -> i32 {
        (s.len() * mem::size_of::<T>()) as i32
    }

}

pub(crate) fn display_as_mat(s : &[f32], ncols : usize) -> String {
    use nalgebra::DMatrix;
    format!("{:.4}", DMatrix::from_iterator(ncols, s.len() / ncols, s.iter().cloned()).transpose() )
}