summaryrefslogtreecommitdiff
path: root/midi-dials/Drivers/CMSIS/DSP/DSP_Lib_TestSuite/Common/inc/complex_math_tests/complex_math_templates.h
blob: 3b7f22fe5eaf4d0ad225fee73d8dc4cccce8eb75 (plain)
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
210
211
212
213
214
215
216
217
218
219
220
221
222
#ifndef _COMPLEX_MATH_TEMPLATES_H_
#define _COMPLEX_MATH_TEMPLATES_H_

/*--------------------------------------------------------------------------------*/
/* Includes */
/*--------------------------------------------------------------------------------*/
#include "test_templates.h"

/*--------------------------------------------------------------------------------*/
/* Group Specific Templates */
/*--------------------------------------------------------------------------------*/

/**
 *  Compare the real outputs from the function under test and the reference
 *  function.
 */
#define COMPLEX_MATH_COMPARE_RE_INTERFACE(block_size, output_type)  \
    TEST_ASSERT_BUFFERS_EQUAL(                                      \
        complex_math_output_ref_a.data_ptr,                         \
        complex_math_output_fut_a.data_ptr,                         \
        block_size * sizeof(output_type))

/**
 *  Compare the real and imaginary outputs from the function under test and the
 *  reference function.
 */
#define COMPLEX_MATH_COMPARE_CMPLX_INTERFACE(block_size, output_type)   \
    do                                                                  \
    {                                                                   \
        COMPLEX_MATH_COMPARE_RE_INTERFACE(block_size * 2, output_type); \
    } while (0)


/*
 * Comparison SNR thresholds for the data types used in complex_math_tests.
 */
#define COMPLEX_MATH_SNR_THRESHOLD_float32_t 120
#define COMPLEX_MATH_SNR_THRESHOLD_q31_t 100
#define COMPLEX_MATH_SNR_THRESHOLD_q15_t 75

/**
 *  Compare reference and fut outputs using SNR.
 *
 *  The output_suffix specifies which output buffers to use for the
 *  comparison. An output_suffix of 'a' expands to the following buffers:
 *
 *  - complex_math_output_f32_ref_a
 *  - complex_math_output_f32_fut_a
 *  - complex_math_output_ref_a
 *  - complex_math_output_fut_a
 *
 *  @note The outputs are converted to float32_t before comparison.
 */
#define COMPLEX_MATH_SNR_COMPARE_OUT_INTERFACE(block_size,      \
                                               output_type,     \
                                               output_suffix)   \
    do                                                          \
    {                                                           \
        TEST_CONVERT_AND_ASSERT_SNR(                            \
            complex_math_output_f32_ref_##output_suffix,        \
            complex_math_output_ref_##output_suffix.data_ptr,   \
            complex_math_output_f32_fut_##output_suffix,        \
            complex_math_output_fut_##output_suffix.data_ptr,   \
            block_size,                                         \
            output_type,                                        \
            COMPLEX_MATH_SNR_THRESHOLD_##output_type            \
            );                                                  \
    } while (0)

/**
 *  Specification of #COMPLEX_MATH_SNR_COMPARE_INTERFACE() for real outputs.
 */
#define COMPLEX_MATH_SNR_COMPARE_RE_INTERFACE(block_size,       \
                                                   output_type) \
    COMPLEX_MATH_SNR_COMPARE_OUT_INTERFACE(block_size,          \
                                           output_type,         \
                                           a)

/**
 *  Specification of #COMPLEX_MATH_SNR_COMPARE_INTERFACE() for complex outputs.
 */
#define COMPLEX_MATH_SNR_COMPARE_CMPLX_INTERFACE(block_size,    \
                                                 output_type)   \
        COMPLEX_MATH_SNR_COMPARE_OUT_INTERFACE(block_size * 2,  \
                                               output_type,     \
                                               a)

/**
 *  Compare reference and fut split outputs using SNR.
 *
 *  'Split' refers to two separate output buffers; one for real and one for
 *  complex.
 */
#define COMPLEX_MATH_SNR_COMPARE_SPLIT_INTERFACE(block_size,    \
                                                 output_type)   \
        do                                                      \
        {                                                       \
            COMPLEX_MATH_SNR_COMPARE_OUT_INTERFACE(block_size,  \
                                                   output_type, \
                                                   a);          \
            COMPLEX_MATH_SNR_COMPARE_OUT_INTERFACE(block_size,  \
                                                   output_type, \
                                                   b);          \
        } while (0)


/*--------------------------------------------------------------------------------*/
/* Input Interfaces */
/*--------------------------------------------------------------------------------*/
/*
 *  General:
 *  Input interfaces provide inputs to functions inside test templates.  They
 *  ONLY provide the inputs.  The output variables should be hard coded.
 *
 *  The input interfaces must have the following format:
 *
 *  ARM_xxx_INPUT_INTERFACE() or
 *  REF_xxx_INPUT_INTERFACE()
 *
 *  The xxx must be lowercase, and is intended to be the indentifying substring
 *  in the function's name.  Acceptable values are 'sub' or 'add' from the
 *  functions arm_add_q31.
 */

#define ARM_cmplx_conj_INPUT_INTERFACE(input, block_size)           \
    PAREN(input, complex_math_output_fut_a.data_ptr, block_size)

#define REF_cmplx_conj_INPUT_INTERFACE(input, block_size)           \
    PAREN(input, complex_math_output_ref_a.data_ptr, block_size)

#define ARM_cmplx_dot_prod_INPUT_INTERFACE(input_a, input_b, block_size) \
    PAREN(input_a, input_b, block_size,                                 \
          complex_math_output_fut_a.data_ptr,                          \
          complex_math_output_fut_b.data_ptr)

#define REF_cmplx_dot_prod_INPUT_INTERFACE(input_a, input_b, block_size) \
    PAREN(input_a, input_b, block_size,                                 \
          complex_math_output_ref_a.data_ptr,                          \
          complex_math_output_ref_b.data_ptr)

#define ARM_cmplx_mag_INPUT_INTERFACE(input, block_size)            \
    PAREN(input, complex_math_output_fut_a.data_ptr, block_size)

#define REF_cmplx_mag_INPUT_INTERFACE(input, block_size)            \
    PAREN(input, complex_math_output_ref_a.data_ptr, block_size)

#define ARM_cmplx_mag_squared_INPUT_INTERFACE(input, block_size)    \
    PAREN(input, complex_math_output_fut_a.data_ptr, block_size)

#define REF_cmplx_mag_squared_INPUT_INTERFACE(input, block_size)    \
    PAREN(input, complex_math_output_ref_a.data_ptr, block_size)

#define ARM_cmplx_mult_cmplx_INPUT_INTERFACE(input_a, input_b, block_size) \
    PAREN(input_a, input_b, complex_math_output_fut_a.data_ptr, block_size)

#define REF_cmplx_mult_cmplx_INPUT_INTERFACE(input_a, input_b, block_size) \
    PAREN(input_a, input_b, complex_math_output_ref_a.data_ptr, block_size)

#define ARM_cmplx_mult_real_INPUT_INTERFACE(input_a, input_b, block_size) \
    PAREN(input_a, input_b, complex_math_output_fut_a.data_ptr, block_size)

#define REF_cmplx_mult_real_INPUT_INTERFACE(input_a, input_b, block_size) \
    PAREN(input_a, input_b, complex_math_output_ref_a.data_ptr, block_size)

/*--------------------------------------------------------------------------------*/
/* Test Templates */
/*--------------------------------------------------------------------------------*/

/**
 *  Specialization of #TEST_TEMPLATE_BUF1_BLK() for complex math tests.
 *
 *  @note This macro relies on the existance of ARM_xxx_INPUT_INTERFACE and
 *  REF_xxx_INPUT_INTERFACEs.
 */
#define COMPLEX_MATH_DEFINE_TEST_TEMPLATE_BUF1_BLK(fn_name,         \
                                                   suffix,          \
                                                   input_type,      \
                                                   output_type,     \
                                                   comparison_interface) \
    JTEST_DEFINE_TEST(arm_##fn_name##_##suffix##_test,              \
                      arm_##fn_name##_##suffix)                     \
    {                                                               \
        TEST_TEMPLATE_BUF1_BLK(                                     \
            complex_math_f_all,                                     \
            complex_math_block_sizes,                               \
            input_type,                                             \
            output_type,                                            \
            arm_##fn_name##_##suffix,                               \
            ARM_##fn_name##_INPUT_INTERFACE,                        \
            ref_##fn_name##_##suffix,                               \
            REF_##fn_name##_INPUT_INTERFACE,                        \
            comparison_interface);                                  \
    }

/**
 *  Specialization of #TEST_TEMPLATE_BUF2_BLK1() for complex math tests.
 *
 *  @note This macro relies on the existance of ARM_xxx_INPUT_INTERFACE and
 *  REF_xxx_INPUT_INTERFACEs.
 */
#define COMPLEX_MATH_DEFINE_TEST_TEMPLATE_BUF2_BLK(fn_name,         \
                                                   suffix,          \
                                                   input_type,      \
                                                   output_type,     \
                                                   comparison_interface) \
    JTEST_DEFINE_TEST(arm_##fn_name##_##suffix##_test,              \
                      arm_##fn_name##_##suffix)                     \
    {                                                               \
        TEST_TEMPLATE_BUF2_BLK(                                     \
            complex_math_f_all,                                     \
            complex_math_f_all,                                     \
            complex_math_block_sizes,                               \
            input_type,                                             \
            output_type,                                            \
            arm_##fn_name##_##suffix,                               \
            ARM_##fn_name##_INPUT_INTERFACE,                        \
            ref_##fn_name##_##suffix,                               \
            REF_##fn_name##_INPUT_INTERFACE,                        \
            comparison_interface);                                  \
    }

#endif /* _COMPLEX_MATH_TEMPLATES_H_ */