irapt 0.1.1

An implementation of the IRAPT pitch estimation algorithm
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209

use core::str::FromStr;

pub fn parse_csv<T: FromStr>(data: &'static [u8]) -> impl Iterator<Item = impl Iterator<Item = T> + ExactSizeIterator> {
    let mut csv_reader = csv::ReaderBuilder::new();
    csv_reader.has_headers(false);
    let expected = csv_reader.from_reader(data).into_records();
    let expected_rows = expected.map(|expected| {
        let expected = expected.unwrap();
        (0..expected.len()).map(move |index| {
            let expected_str = expected.get(index).unwrap();
            expected_str.parse::<T>().unwrap_or_else(|_| panic!("unparsable csv test data"))
        })
    });
    expected_rows
}

/// Asserts that two expressions evaluating to iterators yielding float values, or structs containing float values,
/// are approximately equal to each other.
///
/// The third argument to the macro is either:
///
///  * A numeric literal, indicating absolute comparison should be performed, i.e. the two numbers should be within
///    the given distance of each other.
///
///  * A numeric literal followed by `%`, indicating relative comparison should be performed, i.e. the smaller value
///    should be within the given percentage of the larger value.
///
/// If the values yielded from the iterators are structs, the fields to compare are specified as the fourth
/// argument, preceded by dots and separated by spaces.
///
/// On panic, this macro will print the values of the mismatching float values and the index they were yielded at
/// from their iterators.
///
/// Like [`assert!`], a custom panic message can be provided as the last arguments.
///
/// # Examples
///
/// ```
/// assert_iter_approx_eq!(&[0.010f64, 0.020f64], &[0.011f64, 0.021f64], 1e-2);
/// assert_iter_approx_eq!(&[100f64, 181f64], &[91f64, 200f64], 10%);
/// assert_iter_approx_eq!(&[100f64, 181f64], &[91f64, 200f64], 10%, "custom message with an {}", "argument");
///
/// struct Foo {
///     x: f64,
///     y: f64,
/// }
/// let actual = [Foo { x: 100.0, y: 181.0 }];
/// let expected = [Foo { x: 91.0, y: 200.0 }];
/// assert_iter_approx_eq!(&actual, &expected, 10%, .x .y);
/// ```
macro_rules! assert_iter_approx_eq {
    // absolute comparison within given distance
    ($actual:expr, $expected:expr, $max_dist:literal $(, $($arg:tt)*)?) => ({
        __assert_iter_approx_eq_impl!(
            $actual,
            $expected,
            max_dist => $max_dist,
            (_actual, _expected) => max_dist
                $(, $($arg)*)?
        );
    });

    // relative comparison within given percentage of larger number
    ($actual:expr, $expected:expr, $max_percentage_dist:literal % $(, $($arg:tt)*)?) => ({
        __assert_iter_approx_eq_impl!(
            $actual,
            $expected,
            max_percentage_dist => f64::from($max_percentage_dist) / 100.0,
            (actual, expected) => f64::from(actual.clone()).abs().max(f64::from(expected.clone()).abs()) * max_percentage_dist
                $(, $($arg)*)?
        );
    });
}

macro_rules! __assert_iter_approx_eq_impl {
    // plain comparison between two values
    (
        $actual:expr,
        $expected:expr,
        $max_dist_ident:ident => $max_dist:expr,
        ($actual_item_ident:ident, $expected_item_ident:ident) => $item_max_dist:expr
            $(, $($arg:tt),* $(,)?)?
    ) => ({
        __assert_iter_approx_eq_impl_2!(
            actual => $actual,
            expected => $expected,
            $max_dist_ident => $max_dist,
            format => ($($($arg),*)?),
            index => __assert_approx_eq_impl!(
                actual.clone() => format_args!(concat!(stringify!($actual), "[{}]"), index),
                expected.clone() => format_args!(concat!(stringify!($expected), "[{}]"), index),
                {
                    let ($actual_item_ident, $expected_item_ident) = (actual, expected);
                    $item_max_dist
                },
                "{}",
                format,
            )
        )
    });

    // comparison between fields of a struct
    (
        $actual:expr,
        $expected:expr,
        $max_dist_ident:ident => $max_dist:expr,
        ($actual_item_ident:ident, $expected_item_ident:ident) => $item_max_dist:expr,
        $(.$field:ident)+ $(, $($arg:tt),* $(,)?)?
    ) => ({
        __assert_iter_approx_eq_impl_2!(
            actual => $actual,
            expected => $expected,
            $max_dist_ident => $max_dist,
            format => ($($($arg),*)?),
            index => { $(__assert_approx_eq_impl!(
                actual.$field => format_args!(concat!(stringify!($actual), "[{}].", stringify!($field)), index),
                expected.$field => format_args!(concat!(stringify!($expected), "[{}].", stringify!($field)), index),
                {
                    let ($actual_item_ident, $expected_item_ident) = (actual.$field, expected.$field);
                    $item_max_dist
                },
                "{}",
                format,
            ); )+ }
        )
    });
}

macro_rules! __assert_iter_approx_eq_impl_2 {
    ($actual_ident:ident => $actual:expr, $expected_ident:ident => $expected:expr, $max_dist_ident:ident => $max_dist:expr,
     $format_ident:ident => (), $index_ident:ident => $code:expr) => (
        __assert_iter_approx_eq_impl_2!($actual_ident => $actual, $expected_ident => $expected, $max_dist_ident => $max_dist,
                                        $format_ident => (""), $index_ident => $code)
    );
    ($actual_ident:ident => $actual:expr, $expected_ident:ident => $expected:expr, $max_dist_ident:ident => $max_dist:expr, $format_ident:ident => ($($arg:tt),+),
     $index_ident:ident => $code:expr) => ({
         use itertools::zip_eq;
         let $max_dist_ident = $max_dist;
         zip_eq($actual, $expected).enumerate().for_each(|($index_ident, ($actual_ident, $expected_ident))| {
             match format_args!($($arg),+) {
                 $format_ident => {
                     $code
                 }
             }
         });
     });
}

macro_rules! __assert_approx_eq_impl {
    ($actual:expr => $actual_fmt:expr, $expected:expr => $expected_fmt:expr, $max_dist:expr, $($arg:tt),+ $(,)?) => ({
        let dist = f64::from($actual - $expected).abs();
        if dist > $max_dist {
            assert_eq!(
                $actual,
                $expected,
                "abs({} - {}) = {} > {}: {}",
                $actual_fmt,
                $expected_fmt,
                dist,
                $max_dist,
                format_args!($($arg),+),
            );
        }
    })
}

#[test]
fn test_assert_iter_approx_eq() {
    assert_iter_approx_eq!(&[0.010f64, 0.020f64], &[0.011f64, 0.021f64], 1e-2);
    assert_iter_approx_eq!(&[0.010f64, 0.020f64], &[0.011f64, 0.021f64], 1e-2,);
    assert_iter_approx_eq!(&[0.010f64, 0.020f64], &[0.011f64, 0.021f64], 1e-2, "");
    assert_iter_approx_eq!(&[0.010f64, 0.020f64], &[0.011f64, 0.021f64], 1e-2, "",);
    assert_iter_approx_eq!(&[0.010f64, 0.020f64], &[0.011f64, 0.021f64], 1e-2, "{}", "");
    assert_iter_approx_eq!(&[0.010f64, 0.020f64], &[0.011f64, 0.021f64], 1e-2, "{}", "",);

    assert_iter_approx_eq!(&[100f64, 181f64], &[91f64, 200f64], 10%);
    assert_iter_approx_eq!(&[100f64, 181f64], &[91f64, 200f64], 10%,);
    assert_iter_approx_eq!(&[100f64, 181f64], &[91f64, 200f64], 10%, "");
    assert_iter_approx_eq!(&[100f64, 181f64], &[91f64, 200f64], 10%, "",);
    assert_iter_approx_eq!(&[100f64, 181f64], &[91f64, 200f64], 10%, "{}", "");
    assert_iter_approx_eq!(&[100f64, 181f64], &[91f64, 200f64], 10%, "{}", "",);

    struct Foo {
        x: f64,
        y: f64,
    }
    let actual = [Foo { x: 100.0, y: 181.0 }];
    let expected = [Foo { x: 91.0, y: 200.0 }];
    assert_iter_approx_eq!(&actual, &expected, 10%, .x);
    assert_iter_approx_eq!(&actual, &expected, 10%, .x,);
    assert_iter_approx_eq!(&actual, &expected, 10%, .x .y);
    assert_iter_approx_eq!(&actual, &expected, 10%, .x .y,);
    assert_iter_approx_eq!(&actual, &expected, 10%, .x .y, "");
    assert_iter_approx_eq!(&actual, &expected, 10%, .x .y, "",);
    assert_iter_approx_eq!(&actual, &expected, 10%, .x .y, "{}", "");
    assert_iter_approx_eq!(&actual, &expected, 10%, .x .y, "{}", "",);
}

#[test]
#[should_panic]
fn test_assert_iter_approx_eq_absolute_fail() {
    assert_iter_approx_eq!(&[100.0f64], &[100.2f64], 1e-1);
}

#[test]
#[should_panic]
fn test_assert_iter_approx_eq_relative_fail() {
    assert_iter_approx_eq!(&[100f64], &[121f64], 10%);
}