xref: /aosp_15_r20/external/ComputeLibrary/tests/validation/Validation.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1*c217d954SCole Faust /*
2*c217d954SCole Faust  * Copyright (c) 2017-2022 Arm Limited.
3*c217d954SCole Faust  *
4*c217d954SCole Faust  * SPDX-License-Identifier: MIT
5*c217d954SCole Faust  *
6*c217d954SCole Faust  * Permission is hereby granted, free of charge, to any person obtaining a copy
7*c217d954SCole Faust  * of this software and associated documentation files (the "Software"), to
8*c217d954SCole Faust  * deal in the Software without restriction, including without limitation the
9*c217d954SCole Faust  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10*c217d954SCole Faust  * sell copies of the Software, and to permit persons to whom the Software is
11*c217d954SCole Faust  * furnished to do so, subject to the following conditions:
12*c217d954SCole Faust  *
13*c217d954SCole Faust  * The above copyright notice and this permission notice shall be included in all
14*c217d954SCole Faust  * copies or substantial portions of the Software.
15*c217d954SCole Faust  *
16*c217d954SCole Faust  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17*c217d954SCole Faust  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18*c217d954SCole Faust  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19*c217d954SCole Faust  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20*c217d954SCole Faust  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21*c217d954SCole Faust  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22*c217d954SCole Faust  * SOFTWARE.
23*c217d954SCole Faust  */
24*c217d954SCole Faust #ifndef ARM_COMPUTE_TEST_VALIDATION_H
25*c217d954SCole Faust #define ARM_COMPUTE_TEST_VALIDATION_H
26*c217d954SCole Faust 
27*c217d954SCole Faust #include "arm_compute/core/IArray.h"
28*c217d954SCole Faust #include "arm_compute/core/Types.h"
29*c217d954SCole Faust #include "support/ToolchainSupport.h"
30*c217d954SCole Faust #include "tests/IAccessor.h"
31*c217d954SCole Faust #include "tests/SimpleTensor.h"
32*c217d954SCole Faust #include "tests/Types.h"
33*c217d954SCole Faust #include "tests/Utils.h"
34*c217d954SCole Faust #include "tests/framework/Asserts.h"
35*c217d954SCole Faust #include "tests/framework/Exceptions.h"
36*c217d954SCole Faust #include "utils/TypePrinter.h"
37*c217d954SCole Faust 
38*c217d954SCole Faust #include <iomanip>
39*c217d954SCole Faust #include <ios>
40*c217d954SCole Faust #include <vector>
41*c217d954SCole Faust 
42*c217d954SCole Faust namespace arm_compute
43*c217d954SCole Faust {
44*c217d954SCole Faust namespace test
45*c217d954SCole Faust {
46*c217d954SCole Faust namespace validation
47*c217d954SCole Faust {
48*c217d954SCole Faust namespace
49*c217d954SCole Faust {
50*c217d954SCole Faust // Compare if 2 values are both infinities and if they are "equal" (has the same sign)
51*c217d954SCole Faust template <typename T>
are_equal_infs(T val0,T val1)52*c217d954SCole Faust inline bool are_equal_infs(T val0, T val1)
53*c217d954SCole Faust {
54*c217d954SCole Faust     const auto same_sign = support::cpp11::signbit(val0) == support::cpp11::signbit(val1);
55*c217d954SCole Faust     return (!support::cpp11::isfinite(val0)) && (!support::cpp11::isfinite(val1)) && same_sign;
56*c217d954SCole Faust }
57*c217d954SCole Faust } // namespace
58*c217d954SCole Faust 
59*c217d954SCole Faust /** Class reprensenting an absolute tolerance value. */
60*c217d954SCole Faust template <typename T>
61*c217d954SCole Faust class AbsoluteTolerance
62*c217d954SCole Faust {
63*c217d954SCole Faust public:
64*c217d954SCole Faust     /** Underlying type. */
65*c217d954SCole Faust     using value_type = T;
66*c217d954SCole Faust 
67*c217d954SCole Faust     /* Default constructor.
68*c217d954SCole Faust      *
69*c217d954SCole Faust      * Initialises the tolerance to 0.
70*c217d954SCole Faust      */
71*c217d954SCole Faust     AbsoluteTolerance() = default;
72*c217d954SCole Faust 
73*c217d954SCole Faust     /** Constructor.
74*c217d954SCole Faust      *
75*c217d954SCole Faust      * @param[in] value Absolute tolerance value.
76*c217d954SCole Faust      */
AbsoluteTolerance(T value)77*c217d954SCole Faust     explicit constexpr AbsoluteTolerance(T value)
78*c217d954SCole Faust         : _value{ value }
79*c217d954SCole Faust     {
80*c217d954SCole Faust     }
81*c217d954SCole Faust 
82*c217d954SCole Faust     /** Implicit conversion to the underlying type.
83*c217d954SCole Faust      *
84*c217d954SCole Faust      * @return the underlying type.
85*c217d954SCole Faust      */
T()86*c217d954SCole Faust     constexpr operator T() const
87*c217d954SCole Faust     {
88*c217d954SCole Faust         return _value;
89*c217d954SCole Faust     }
90*c217d954SCole Faust 
91*c217d954SCole Faust private:
92*c217d954SCole Faust     T _value{ std::numeric_limits<T>::epsilon() };
93*c217d954SCole Faust };
94*c217d954SCole Faust 
95*c217d954SCole Faust /** Class reprensenting a relative tolerance value. */
96*c217d954SCole Faust template <typename T>
97*c217d954SCole Faust class RelativeTolerance
98*c217d954SCole Faust {
99*c217d954SCole Faust public:
100*c217d954SCole Faust     /** Underlying type. */
101*c217d954SCole Faust     using value_type = T;
102*c217d954SCole Faust 
103*c217d954SCole Faust     /* Default constructor.
104*c217d954SCole Faust      *
105*c217d954SCole Faust      * Initialises the tolerance to 0.
106*c217d954SCole Faust      */
107*c217d954SCole Faust     RelativeTolerance() = default;
108*c217d954SCole Faust 
109*c217d954SCole Faust     /** Constructor.
110*c217d954SCole Faust      *
111*c217d954SCole Faust      * @param[in] value Relative tolerance value.
112*c217d954SCole Faust      */
RelativeTolerance(value_type value)113*c217d954SCole Faust     explicit constexpr RelativeTolerance(value_type value)
114*c217d954SCole Faust         : _value{ value }
115*c217d954SCole Faust     {
116*c217d954SCole Faust     }
117*c217d954SCole Faust 
118*c217d954SCole Faust     /** Implicit conversion to the underlying type.
119*c217d954SCole Faust      *
120*c217d954SCole Faust      * @return the underlying type.
121*c217d954SCole Faust      */
value_type()122*c217d954SCole Faust     constexpr operator value_type() const
123*c217d954SCole Faust     {
124*c217d954SCole Faust         return _value;
125*c217d954SCole Faust     }
126*c217d954SCole Faust 
127*c217d954SCole Faust private:
128*c217d954SCole Faust     value_type _value{ std::numeric_limits<T>::epsilon() };
129*c217d954SCole Faust };
130*c217d954SCole Faust 
131*c217d954SCole Faust /** Print AbsoluteTolerance type. */
132*c217d954SCole Faust template <typename T>
133*c217d954SCole Faust inline ::std::ostream &operator<<(::std::ostream &os, const AbsoluteTolerance<T> &tolerance)
134*c217d954SCole Faust {
135*c217d954SCole Faust     os << static_cast<typename AbsoluteTolerance<T>::value_type>(tolerance);
136*c217d954SCole Faust 
137*c217d954SCole Faust     return os;
138*c217d954SCole Faust }
139*c217d954SCole Faust 
140*c217d954SCole Faust /** Print RelativeTolerance type. */
141*c217d954SCole Faust template <typename T>
142*c217d954SCole Faust inline ::std::ostream &operator<<(::std::ostream &os, const RelativeTolerance<T> &tolerance)
143*c217d954SCole Faust {
144*c217d954SCole Faust     os << static_cast<typename RelativeTolerance<T>::value_type>(tolerance);
145*c217d954SCole Faust 
146*c217d954SCole Faust     return os;
147*c217d954SCole Faust }
148*c217d954SCole Faust 
149*c217d954SCole Faust template <typename T>
150*c217d954SCole Faust bool compare_dimensions(const Dimensions<T> &dimensions1, const Dimensions<T> &dimensions2, const DataLayout &data_layout = DataLayout::NCHW)
151*c217d954SCole Faust {
152*c217d954SCole Faust     ARM_COMPUTE_ERROR_ON(data_layout == DataLayout::UNKNOWN);
153*c217d954SCole Faust 
154*c217d954SCole Faust     if(data_layout != DataLayout::NHWC)
155*c217d954SCole Faust     {
156*c217d954SCole Faust         if(dimensions1.num_dimensions() != dimensions2.num_dimensions())
157*c217d954SCole Faust         {
158*c217d954SCole Faust             return false;
159*c217d954SCole Faust         }
160*c217d954SCole Faust 
161*c217d954SCole Faust         for(unsigned int i = 0; i < dimensions1.num_dimensions(); ++i)
162*c217d954SCole Faust         {
163*c217d954SCole Faust             if(dimensions1[i] != dimensions2[i])
164*c217d954SCole Faust             {
165*c217d954SCole Faust                 return false;
166*c217d954SCole Faust             }
167*c217d954SCole Faust         }
168*c217d954SCole Faust     }
169*c217d954SCole Faust     else
170*c217d954SCole Faust     {
171*c217d954SCole Faust         // In case a 1D/2D shape becomes 3D after permutation, the permuted tensor will have two/one dimension(s) more and the first (two) value(s) will be 1
172*c217d954SCole Faust         // clang-format off
173*c217d954SCole Faust         const auto max_dims = std::max(dimensions1.num_dimensions(), dimensions2.num_dimensions());
174*c217d954SCole Faust         for(unsigned int i = 3; i < max_dims; ++i)
175*c217d954SCole Faust         {
176*c217d954SCole Faust             if(dimensions1[i] != dimensions2[i])
177*c217d954SCole Faust             {
178*c217d954SCole Faust                 return false;
179*c217d954SCole Faust             }
180*c217d954SCole Faust         }
181*c217d954SCole Faust         // clang-format on
182*c217d954SCole Faust 
183*c217d954SCole Faust         if((dimensions1[0] != dimensions2[2]) || (dimensions1[1] != dimensions2[0]) || (dimensions1[2] != dimensions2[1]))
184*c217d954SCole Faust         {
185*c217d954SCole Faust             return false;
186*c217d954SCole Faust         }
187*c217d954SCole Faust     }
188*c217d954SCole Faust 
189*c217d954SCole Faust     return true;
190*c217d954SCole Faust }
191*c217d954SCole Faust 
192*c217d954SCole Faust /** Validate valid regions.
193*c217d954SCole Faust  *
194*c217d954SCole Faust  * - Dimensionality has to be the same.
195*c217d954SCole Faust  * - Anchors have to match.
196*c217d954SCole Faust  * - Shapes have to match.
197*c217d954SCole Faust  */
198*c217d954SCole Faust void validate(const arm_compute::ValidRegion &region, const arm_compute::ValidRegion &reference);
199*c217d954SCole Faust 
200*c217d954SCole Faust /** Validate padding.
201*c217d954SCole Faust  *
202*c217d954SCole Faust  * Padding on all sides has to be the same.
203*c217d954SCole Faust  */
204*c217d954SCole Faust void validate(const arm_compute::PaddingSize &padding, const arm_compute::PaddingSize &reference);
205*c217d954SCole Faust 
206*c217d954SCole Faust /** Validate padding.
207*c217d954SCole Faust  *
208*c217d954SCole Faust  * Padding on all sides has to be the same.
209*c217d954SCole Faust  */
210*c217d954SCole Faust void validate(const arm_compute::PaddingSize &padding, const arm_compute::PaddingSize &width_reference, const arm_compute::PaddingSize &height_reference);
211*c217d954SCole Faust 
212*c217d954SCole Faust /** Validate tensors.
213*c217d954SCole Faust  *
214*c217d954SCole Faust  * - Dimensionality has to be the same.
215*c217d954SCole Faust  * - All values have to match.
216*c217d954SCole Faust  *
217*c217d954SCole Faust  * @note: wrap_range allows cases where reference tensor rounds up to the wrapping point, causing it to wrap around to
218*c217d954SCole Faust  * zero while the test tensor stays at wrapping point to pass. This may permit true erroneous cases (difference between
219*c217d954SCole Faust  * reference tensor and test tensor is multiple of wrap_range), but such errors would be detected by
220*c217d954SCole Faust  * other test cases.
221*c217d954SCole Faust  */
222*c217d954SCole Faust template <typename T, typename U = AbsoluteTolerance<T>>
223*c217d954SCole Faust void validate(const IAccessor &tensor, const SimpleTensor<T> &reference, U tolerance_value = U(), float tolerance_number = 0.f, float absolute_tolerance_value = 0.f);
224*c217d954SCole Faust 
225*c217d954SCole Faust /** Validate tensors with valid region.
226*c217d954SCole Faust  *
227*c217d954SCole Faust  * - Dimensionality has to be the same.
228*c217d954SCole Faust  * - All values have to match.
229*c217d954SCole Faust  *
230*c217d954SCole Faust  * @note: wrap_range allows cases where reference tensor rounds up to the wrapping point, causing it to wrap around to
231*c217d954SCole Faust  * zero while the test tensor stays at wrapping point to pass. This may permit true erroneous cases (difference between
232*c217d954SCole Faust  * reference tensor and test tensor is multiple of wrap_range), but such errors would be detected by
233*c217d954SCole Faust  * other test cases.
234*c217d954SCole Faust  */
235*c217d954SCole Faust template <typename T, typename U = AbsoluteTolerance<T>>
236*c217d954SCole Faust void validate(const IAccessor &tensor, const SimpleTensor<T> &reference, const ValidRegion &valid_region, U tolerance_value = U(), float tolerance_number = 0.f, float absolute_tolerance_value = 0.f);
237*c217d954SCole Faust 
238*c217d954SCole Faust /** Validate tensors with valid mask.
239*c217d954SCole Faust  *
240*c217d954SCole Faust  * - Dimensionality has to be the same.
241*c217d954SCole Faust  * - All values have to match.
242*c217d954SCole Faust  *
243*c217d954SCole Faust  * @note: wrap_range allows cases where reference tensor rounds up to the wrapping point, causing it to wrap around to
244*c217d954SCole Faust  * zero while the test tensor stays at wrapping point to pass. This may permit true erroneous cases (difference between
245*c217d954SCole Faust  * reference tensor and test tensor is multiple of wrap_range), but such errors would be detected by
246*c217d954SCole Faust  * other test cases.
247*c217d954SCole Faust  */
248*c217d954SCole Faust template <typename T, typename U = AbsoluteTolerance<T>>
249*c217d954SCole Faust void validate(const IAccessor &tensor, const SimpleTensor<T> &reference, const SimpleTensor<T> &valid_mask, U tolerance_value = U(), float tolerance_number = 0.f,
250*c217d954SCole Faust               float absolute_tolerance_value = 0.f);
251*c217d954SCole Faust 
252*c217d954SCole Faust /** Validate tensors against constant value.
253*c217d954SCole Faust  *
254*c217d954SCole Faust  * - All values have to match.
255*c217d954SCole Faust  */
256*c217d954SCole Faust void validate(const IAccessor &tensor, const void *reference_value);
257*c217d954SCole Faust 
258*c217d954SCole Faust /** Validate border against a constant value.
259*c217d954SCole Faust  *
260*c217d954SCole Faust  * - All border values have to match the specified value if mode is CONSTANT.
261*c217d954SCole Faust  * - All border values have to be replicated if mode is REPLICATE.
262*c217d954SCole Faust  * - Nothing is validated for mode UNDEFINED.
263*c217d954SCole Faust  */
264*c217d954SCole Faust void validate(const IAccessor &tensor, BorderSize border_size, const BorderMode &border_mode, const void *border_value);
265*c217d954SCole Faust 
266*c217d954SCole Faust /** Validate classified labels against expected ones.
267*c217d954SCole Faust  *
268*c217d954SCole Faust  * - All values should match
269*c217d954SCole Faust  */
270*c217d954SCole Faust void validate(std::vector<unsigned int> classified_labels, std::vector<unsigned int> expected_labels);
271*c217d954SCole Faust 
272*c217d954SCole Faust /** Validate float value.
273*c217d954SCole Faust  *
274*c217d954SCole Faust  * - All values should match
275*c217d954SCole Faust  */
276*c217d954SCole Faust template <typename T, typename U = AbsoluteTolerance<T>>
277*c217d954SCole Faust bool validate(T target, T reference, U tolerance = AbsoluteTolerance<T>());
278*c217d954SCole Faust 
279*c217d954SCole Faust template <typename T>
280*c217d954SCole Faust struct compare_base
281*c217d954SCole Faust {
282*c217d954SCole Faust     /** Construct a comparison object.
283*c217d954SCole Faust      *
284*c217d954SCole Faust      * @param[in] target    Target value.
285*c217d954SCole Faust      * @param[in] reference Reference value.
286*c217d954SCole Faust      * @param[in] tolerance Allowed tolerance.
287*c217d954SCole Faust      */
288*c217d954SCole Faust     compare_base(typename T::value_type target, typename T::value_type reference, T tolerance = T(0))
289*c217d954SCole Faust         : _target{ target }, _reference{ reference }, _tolerance{ tolerance }
290*c217d954SCole Faust     {
291*c217d954SCole Faust     }
292*c217d954SCole Faust 
293*c217d954SCole Faust     typename T::value_type _target{};    /**< Target value */
294*c217d954SCole Faust     typename T::value_type _reference{}; /**< Reference value */
295*c217d954SCole Faust     T                      _tolerance{}; /**< Tolerance value */
296*c217d954SCole Faust };
297*c217d954SCole Faust 
298*c217d954SCole Faust template <typename T>
299*c217d954SCole Faust struct compare;
300*c217d954SCole Faust 
301*c217d954SCole Faust /** Compare values with an absolute tolerance */
302*c217d954SCole Faust template <typename U>
303*c217d954SCole Faust struct compare<AbsoluteTolerance<U>> : public compare_base<AbsoluteTolerance<U>>
304*c217d954SCole Faust {
305*c217d954SCole Faust     using compare_base<AbsoluteTolerance<U>>::compare_base;
306*c217d954SCole Faust 
307*c217d954SCole Faust     /** Perform comparison */
308*c217d954SCole Faust     operator bool() const
309*c217d954SCole Faust     {
310*c217d954SCole Faust         if(are_equal_infs(this->_target, this->_reference))
311*c217d954SCole Faust         {
312*c217d954SCole Faust             return true;
313*c217d954SCole Faust         }
314*c217d954SCole Faust         else if(this->_target == this->_reference)
315*c217d954SCole Faust         {
316*c217d954SCole Faust             return true;
317*c217d954SCole Faust         }
318*c217d954SCole Faust 
319*c217d954SCole Faust         using comparison_type = typename std::conditional<std::is_integral<U>::value, int64_t, U>::type;
320*c217d954SCole Faust 
321*c217d954SCole Faust         const comparison_type abs_difference(std::abs(static_cast<comparison_type>(this->_target) - static_cast<comparison_type>(this->_reference)));
322*c217d954SCole Faust 
323*c217d954SCole Faust         return abs_difference <= static_cast<comparison_type>(this->_tolerance);
324*c217d954SCole Faust     }
325*c217d954SCole Faust };
326*c217d954SCole Faust 
327*c217d954SCole Faust /** Compare values with a relative tolerance */
328*c217d954SCole Faust template <typename U>
329*c217d954SCole Faust struct compare<RelativeTolerance<U>> : public compare_base<RelativeTolerance<U>>
330*c217d954SCole Faust {
331*c217d954SCole Faust     using compare_base<RelativeTolerance<U>>::compare_base;
332*c217d954SCole Faust 
333*c217d954SCole Faust     /** Perform comparison */
334*c217d954SCole Faust     operator bool() const
335*c217d954SCole Faust     {
336*c217d954SCole Faust         if(are_equal_infs(this->_target, this->_reference))
337*c217d954SCole Faust         {
338*c217d954SCole Faust             return true;
339*c217d954SCole Faust         }
340*c217d954SCole Faust         else if(this->_target == this->_reference)
341*c217d954SCole Faust         {
342*c217d954SCole Faust             return true;
343*c217d954SCole Faust         }
344*c217d954SCole Faust 
345*c217d954SCole Faust         const U epsilon = (std::is_same<half, typename std::remove_cv<U>::type>::value || (this->_reference == 0)) ? static_cast<U>(0.01) : static_cast<U>(1e-05);
346*c217d954SCole Faust 
347*c217d954SCole Faust         if(std::abs(static_cast<double>(this->_reference) - static_cast<double>(this->_target)) <= epsilon)
348*c217d954SCole Faust         {
349*c217d954SCole Faust             return true;
350*c217d954SCole Faust         }
351*c217d954SCole Faust         else
352*c217d954SCole Faust         {
353*c217d954SCole Faust             if(static_cast<double>(this->_reference) == 0.0f) // We have checked whether _reference and _target is closing. If _reference is 0 but not closed to _target, it should return false
354*c217d954SCole Faust             {
355*c217d954SCole Faust                 return false;
356*c217d954SCole Faust             }
357*c217d954SCole Faust 
358*c217d954SCole Faust             const double relative_change = std::abs((static_cast<double>(this->_target) - static_cast<double>(this->_reference)) / this->_reference);
359*c217d954SCole Faust 
360*c217d954SCole Faust             return relative_change <= static_cast<U>(this->_tolerance);
361*c217d954SCole Faust         }
362*c217d954SCole Faust     }
363*c217d954SCole Faust };
364*c217d954SCole Faust 
365*c217d954SCole Faust template <typename T, typename U>
366*c217d954SCole Faust void validate(const IAccessor &tensor, const SimpleTensor<T> &reference, U tolerance_value, float tolerance_number, float absolute_tolerance_value)
367*c217d954SCole Faust {
368*c217d954SCole Faust     // Validate with valid region covering the entire shape
369*c217d954SCole Faust     validate(tensor, reference, shape_to_valid_region(reference.shape()), tolerance_value, tolerance_number, absolute_tolerance_value);
370*c217d954SCole Faust }
371*c217d954SCole Faust 
372*c217d954SCole Faust template <typename T, typename U, typename = typename std::enable_if<std::is_integral<T>::value>::type>
373*c217d954SCole Faust void validate_wrap(const IAccessor &tensor, const SimpleTensor<T> &reference, U tolerance_value, float tolerance_number)
374*c217d954SCole Faust {
375*c217d954SCole Faust     // Validate with valid region covering the entire shape
376*c217d954SCole Faust     validate_wrap(tensor, reference, shape_to_valid_region(reference.shape()), tolerance_value, tolerance_number);
377*c217d954SCole Faust }
378*c217d954SCole Faust 
379*c217d954SCole Faust template <typename T, typename U>
380*c217d954SCole Faust void validate(const IAccessor &tensor, const SimpleTensor<T> &reference, const ValidRegion &valid_region, U tolerance_value, float tolerance_number, float absolute_tolerance_value)
381*c217d954SCole Faust {
382*c217d954SCole Faust     if(framework::Framework::get().configure_only() && framework::Framework::get().new_fixture_call())
383*c217d954SCole Faust     {
384*c217d954SCole Faust         return;
385*c217d954SCole Faust     }
386*c217d954SCole Faust 
387*c217d954SCole Faust     uint64_t num_mismatches = 0;
388*c217d954SCole Faust     uint64_t num_elements   = 0;
389*c217d954SCole Faust 
390*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(tensor.element_size(), reference.element_size(), framework::LogLevel::ERRORS);
391*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(tensor.data_type(), reference.data_type(), framework::LogLevel::ERRORS);
392*c217d954SCole Faust 
393*c217d954SCole Faust     if(reference.format() != Format::UNKNOWN)
394*c217d954SCole Faust     {
395*c217d954SCole Faust         ARM_COMPUTE_EXPECT_EQUAL(tensor.format(), reference.format(), framework::LogLevel::ERRORS);
396*c217d954SCole Faust     }
397*c217d954SCole Faust 
398*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(tensor.num_channels(), reference.num_channels(), framework::LogLevel::ERRORS);
399*c217d954SCole Faust     ARM_COMPUTE_EXPECT(compare_dimensions(tensor.shape(), reference.shape(), tensor.data_layout()), framework::LogLevel::ERRORS);
400*c217d954SCole Faust 
401*c217d954SCole Faust     const int min_elements = std::min(tensor.num_elements(), reference.num_elements());
402*c217d954SCole Faust     const int min_channels = std::min(tensor.num_channels(), reference.num_channels());
403*c217d954SCole Faust 
404*c217d954SCole Faust     // Iterate over all elements within valid region, e.g. U8, S16, RGB888, ...
405*c217d954SCole Faust     for(int element_idx = 0; element_idx < min_elements; ++element_idx)
406*c217d954SCole Faust     {
407*c217d954SCole Faust         const Coordinates id = index2coord(reference.shape(), element_idx);
408*c217d954SCole Faust 
409*c217d954SCole Faust         Coordinates target_id(id);
410*c217d954SCole Faust         if(tensor.data_layout() == DataLayout::NHWC)
411*c217d954SCole Faust         {
412*c217d954SCole Faust             permute(target_id, PermutationVector(2U, 0U, 1U));
413*c217d954SCole Faust         }
414*c217d954SCole Faust 
415*c217d954SCole Faust         if(is_in_valid_region(valid_region, id))
416*c217d954SCole Faust         {
417*c217d954SCole Faust             // Iterate over all channels within one element
418*c217d954SCole Faust             for(int c = 0; c < min_channels; ++c)
419*c217d954SCole Faust             {
420*c217d954SCole Faust                 const T &target_value    = reinterpret_cast<const T *>(tensor(target_id))[c];
421*c217d954SCole Faust                 const T &reference_value = reinterpret_cast<const T *>(reference(id))[c];
422*c217d954SCole Faust 
423*c217d954SCole Faust                 if(!compare<U>(target_value, reference_value, tolerance_value))
424*c217d954SCole Faust                 {
425*c217d954SCole Faust                     if(absolute_tolerance_value != 0.f)
426*c217d954SCole Faust                     {
427*c217d954SCole Faust                         const AbsoluteTolerance<float> abs_tolerance(absolute_tolerance_value);
428*c217d954SCole Faust                         if(compare<AbsoluteTolerance<float>>(target_value, reference_value, abs_tolerance))
429*c217d954SCole Faust                         {
430*c217d954SCole Faust                             continue;
431*c217d954SCole Faust                         }
432*c217d954SCole Faust                     }
433*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("id = " << id);
434*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("channel = " << c);
435*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("target = " << std::setprecision(5) << framework::make_printable(target_value));
436*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("reference = " << std::setprecision(5) << framework::make_printable(reference_value));
437*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("tolerance = " << std::setprecision(5) << framework::make_printable(static_cast<typename U::value_type>(tolerance_value)));
438*c217d954SCole Faust                     framework::ARM_COMPUTE_PRINT_INFO();
439*c217d954SCole Faust 
440*c217d954SCole Faust                     ++num_mismatches;
441*c217d954SCole Faust                 }
442*c217d954SCole Faust 
443*c217d954SCole Faust                 ++num_elements;
444*c217d954SCole Faust             }
445*c217d954SCole Faust         }
446*c217d954SCole Faust     }
447*c217d954SCole Faust 
448*c217d954SCole Faust     if(num_elements != 0)
449*c217d954SCole Faust     {
450*c217d954SCole Faust         const uint64_t absolute_tolerance_number = tolerance_number * num_elements;
451*c217d954SCole Faust         const float    percent_mismatches        = static_cast<float>(num_mismatches) / num_elements * 100.f;
452*c217d954SCole Faust 
453*c217d954SCole Faust         ARM_COMPUTE_TEST_INFO(num_mismatches << " values (" << std::fixed << std::setprecision(2) << percent_mismatches
454*c217d954SCole Faust                               << "%) mismatched (maximum tolerated " << std::setprecision(2) << tolerance_number * 100 << "%)");
455*c217d954SCole Faust         ARM_COMPUTE_EXPECT(num_mismatches <= absolute_tolerance_number, framework::LogLevel::ERRORS);
456*c217d954SCole Faust     }
457*c217d954SCole Faust }
458*c217d954SCole Faust 
459*c217d954SCole Faust template <typename T, typename U, typename = typename std::enable_if<std::is_integral<T>::value>::type>
460*c217d954SCole Faust void validate_wrap(const IAccessor &tensor, const SimpleTensor<T> &reference, const ValidRegion &valid_region, U tolerance_value, float tolerance_number)
461*c217d954SCole Faust {
462*c217d954SCole Faust     if(framework::Framework::get().configure_only() && framework::Framework::get().new_fixture_call())
463*c217d954SCole Faust     {
464*c217d954SCole Faust         return;
465*c217d954SCole Faust     }
466*c217d954SCole Faust 
467*c217d954SCole Faust     uint64_t num_mismatches = 0;
468*c217d954SCole Faust     uint64_t num_elements   = 0;
469*c217d954SCole Faust 
470*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(tensor.element_size(), reference.element_size(), framework::LogLevel::ERRORS);
471*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(tensor.data_type(), reference.data_type(), framework::LogLevel::ERRORS);
472*c217d954SCole Faust 
473*c217d954SCole Faust     if(reference.format() != Format::UNKNOWN)
474*c217d954SCole Faust     {
475*c217d954SCole Faust         ARM_COMPUTE_EXPECT_EQUAL(tensor.format(), reference.format(), framework::LogLevel::ERRORS);
476*c217d954SCole Faust     }
477*c217d954SCole Faust 
478*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(tensor.num_channels(), reference.num_channels(), framework::LogLevel::ERRORS);
479*c217d954SCole Faust     ARM_COMPUTE_EXPECT(compare_dimensions(tensor.shape(), reference.shape(), tensor.data_layout()), framework::LogLevel::ERRORS);
480*c217d954SCole Faust 
481*c217d954SCole Faust     const int min_elements = std::min(tensor.num_elements(), reference.num_elements());
482*c217d954SCole Faust     const int min_channels = std::min(tensor.num_channels(), reference.num_channels());
483*c217d954SCole Faust 
484*c217d954SCole Faust     // Iterate over all elements within valid region, e.g. U8, S16, RGB888, ...
485*c217d954SCole Faust     for(int element_idx = 0; element_idx < min_elements; ++element_idx)
486*c217d954SCole Faust     {
487*c217d954SCole Faust         const Coordinates id = index2coord(reference.shape(), element_idx);
488*c217d954SCole Faust 
489*c217d954SCole Faust         Coordinates target_id(id);
490*c217d954SCole Faust         if(tensor.data_layout() == DataLayout::NHWC)
491*c217d954SCole Faust         {
492*c217d954SCole Faust             permute(target_id, PermutationVector(2U, 0U, 1U));
493*c217d954SCole Faust         }
494*c217d954SCole Faust 
495*c217d954SCole Faust         if(is_in_valid_region(valid_region, id))
496*c217d954SCole Faust         {
497*c217d954SCole Faust             // Iterate over all channels within one element
498*c217d954SCole Faust             for(int c = 0; c < min_channels; ++c)
499*c217d954SCole Faust             {
500*c217d954SCole Faust                 const T &target_value    = reinterpret_cast<const T *>(tensor(target_id))[c];
501*c217d954SCole Faust                 const T &reference_value = reinterpret_cast<const T *>(reference(id))[c];
502*c217d954SCole Faust 
503*c217d954SCole Faust                 bool equal = compare<U>(target_value, reference_value, tolerance_value);
504*c217d954SCole Faust 
505*c217d954SCole Faust                 // check for wrapping
506*c217d954SCole Faust                 if(!equal)
507*c217d954SCole Faust                 {
508*c217d954SCole Faust                     if(are_equal_infs(target_value, reference_value))
509*c217d954SCole Faust                     {
510*c217d954SCole Faust                         equal = true;
511*c217d954SCole Faust                     }
512*c217d954SCole Faust                     else
513*c217d954SCole Faust                     {
514*c217d954SCole Faust                         using limits_type = typename std::make_unsigned<T>::type;
515*c217d954SCole Faust 
516*c217d954SCole Faust                         uint64_t max             = std::numeric_limits<limits_type>::max();
517*c217d954SCole Faust                         uint64_t abs_sum         = std::abs(static_cast<int64_t>(target_value)) + std::abs(static_cast<int64_t>(reference_value));
518*c217d954SCole Faust                         uint64_t wrap_difference = max - abs_sum;
519*c217d954SCole Faust 
520*c217d954SCole Faust                         equal = wrap_difference < static_cast<uint64_t>(tolerance_value);
521*c217d954SCole Faust                     }
522*c217d954SCole Faust                 }
523*c217d954SCole Faust 
524*c217d954SCole Faust                 if(!equal)
525*c217d954SCole Faust                 {
526*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("id = " << id);
527*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("channel = " << c);
528*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("target = " << std::setprecision(5) << framework::make_printable(target_value));
529*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("reference = " << std::setprecision(5) << framework::make_printable(reference_value));
530*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("wrap_tolerance = " << std::setprecision(5) << framework::make_printable(static_cast<typename U::value_type>(tolerance_value)));
531*c217d954SCole Faust                     framework::ARM_COMPUTE_PRINT_INFO();
532*c217d954SCole Faust 
533*c217d954SCole Faust                     ++num_mismatches;
534*c217d954SCole Faust                 }
535*c217d954SCole Faust 
536*c217d954SCole Faust                 ++num_elements;
537*c217d954SCole Faust             }
538*c217d954SCole Faust         }
539*c217d954SCole Faust     }
540*c217d954SCole Faust 
541*c217d954SCole Faust     if(num_elements != 0)
542*c217d954SCole Faust     {
543*c217d954SCole Faust         const uint64_t absolute_tolerance_number = tolerance_number * num_elements;
544*c217d954SCole Faust         const float    percent_mismatches        = static_cast<float>(num_mismatches) / num_elements * 100.f;
545*c217d954SCole Faust 
546*c217d954SCole Faust         ARM_COMPUTE_TEST_INFO(num_mismatches << " values (" << std::fixed << std::setprecision(2) << percent_mismatches
547*c217d954SCole Faust                               << "%) mismatched (maximum tolerated " << std::setprecision(2) << tolerance_number * 100 << "%)");
548*c217d954SCole Faust         ARM_COMPUTE_EXPECT(num_mismatches <= absolute_tolerance_number, framework::LogLevel::ERRORS);
549*c217d954SCole Faust     }
550*c217d954SCole Faust }
551*c217d954SCole Faust 
552*c217d954SCole Faust template <typename T, typename U>
553*c217d954SCole Faust void validate(const IAccessor &tensor, const SimpleTensor<T> &reference, const SimpleTensor<T> &valid_mask, U tolerance_value, float tolerance_number, float absolute_tolerance_value)
554*c217d954SCole Faust {
555*c217d954SCole Faust     if(framework::Framework::get().configure_only() && framework::Framework::get().new_fixture_call())
556*c217d954SCole Faust     {
557*c217d954SCole Faust         return;
558*c217d954SCole Faust     }
559*c217d954SCole Faust 
560*c217d954SCole Faust     uint64_t num_mismatches = 0;
561*c217d954SCole Faust     uint64_t num_elements   = 0;
562*c217d954SCole Faust 
563*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(tensor.element_size(), reference.element_size(), framework::LogLevel::ERRORS);
564*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(tensor.data_type(), reference.data_type(), framework::LogLevel::ERRORS);
565*c217d954SCole Faust 
566*c217d954SCole Faust     if(reference.format() != Format::UNKNOWN)
567*c217d954SCole Faust     {
568*c217d954SCole Faust         ARM_COMPUTE_EXPECT_EQUAL(tensor.format(), reference.format(), framework::LogLevel::ERRORS);
569*c217d954SCole Faust     }
570*c217d954SCole Faust 
571*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(tensor.num_channels(), reference.num_channels(), framework::LogLevel::ERRORS);
572*c217d954SCole Faust     ARM_COMPUTE_EXPECT(compare_dimensions(tensor.shape(), reference.shape(), tensor.data_layout()), framework::LogLevel::ERRORS);
573*c217d954SCole Faust 
574*c217d954SCole Faust     const int min_elements = std::min(tensor.num_elements(), reference.num_elements());
575*c217d954SCole Faust     const int min_channels = std::min(tensor.num_channels(), reference.num_channels());
576*c217d954SCole Faust 
577*c217d954SCole Faust     // Iterate over all elements within valid region, e.g. U8, S16, RGB888, ...
578*c217d954SCole Faust     for(int element_idx = 0; element_idx < min_elements; ++element_idx)
579*c217d954SCole Faust     {
580*c217d954SCole Faust         const Coordinates id = index2coord(reference.shape(), element_idx);
581*c217d954SCole Faust 
582*c217d954SCole Faust         Coordinates target_id(id);
583*c217d954SCole Faust         if(tensor.data_layout() == DataLayout::NHWC)
584*c217d954SCole Faust         {
585*c217d954SCole Faust             permute(target_id, PermutationVector(2U, 0U, 1U));
586*c217d954SCole Faust         }
587*c217d954SCole Faust 
588*c217d954SCole Faust         if(valid_mask[element_idx] == 1)
589*c217d954SCole Faust         {
590*c217d954SCole Faust             // Iterate over all channels within one element
591*c217d954SCole Faust             for(int c = 0; c < min_channels; ++c)
592*c217d954SCole Faust             {
593*c217d954SCole Faust                 const T &target_value    = reinterpret_cast<const T *>(tensor(target_id))[c];
594*c217d954SCole Faust                 const T &reference_value = reinterpret_cast<const T *>(reference(id))[c];
595*c217d954SCole Faust 
596*c217d954SCole Faust                 if(!compare<U>(target_value, reference_value, tolerance_value))
597*c217d954SCole Faust                 {
598*c217d954SCole Faust                     if(absolute_tolerance_value != 0.f)
599*c217d954SCole Faust                     {
600*c217d954SCole Faust                         const AbsoluteTolerance<float> abs_tolerance(absolute_tolerance_value);
601*c217d954SCole Faust                         if(compare<AbsoluteTolerance<float>>(target_value, reference_value, abs_tolerance))
602*c217d954SCole Faust                         {
603*c217d954SCole Faust                             continue;
604*c217d954SCole Faust                         }
605*c217d954SCole Faust                     }
606*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("id = " << id);
607*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("channel = " << c);
608*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("target = " << std::setprecision(5) << framework::make_printable(target_value));
609*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("reference = " << std::setprecision(5) << framework::make_printable(reference_value));
610*c217d954SCole Faust                     ARM_COMPUTE_TEST_INFO("tolerance = " << std::setprecision(5) << framework::make_printable(static_cast<typename U::value_type>(tolerance_value)));
611*c217d954SCole Faust                     framework::ARM_COMPUTE_PRINT_INFO();
612*c217d954SCole Faust 
613*c217d954SCole Faust                     ++num_mismatches;
614*c217d954SCole Faust                 }
615*c217d954SCole Faust 
616*c217d954SCole Faust                 ++num_elements;
617*c217d954SCole Faust             }
618*c217d954SCole Faust         }
619*c217d954SCole Faust         else
620*c217d954SCole Faust         {
621*c217d954SCole Faust             ++num_elements;
622*c217d954SCole Faust         }
623*c217d954SCole Faust     }
624*c217d954SCole Faust 
625*c217d954SCole Faust     if(num_elements != 0)
626*c217d954SCole Faust     {
627*c217d954SCole Faust         const uint64_t absolute_tolerance_number = tolerance_number * num_elements;
628*c217d954SCole Faust         const float    percent_mismatches        = static_cast<float>(num_mismatches) / num_elements * 100.f;
629*c217d954SCole Faust 
630*c217d954SCole Faust         ARM_COMPUTE_TEST_INFO(num_mismatches << " values (" << std::fixed << std::setprecision(2) << percent_mismatches
631*c217d954SCole Faust                               << "%) mismatched (maximum tolerated " << std::setprecision(2) << tolerance_number * 100 << "%)");
632*c217d954SCole Faust         ARM_COMPUTE_EXPECT(num_mismatches <= absolute_tolerance_number, framework::LogLevel::ERRORS);
633*c217d954SCole Faust     }
634*c217d954SCole Faust }
635*c217d954SCole Faust 
636*c217d954SCole Faust template <typename T, typename U>
637*c217d954SCole Faust bool validate(T target, T reference, U tolerance)
638*c217d954SCole Faust {
639*c217d954SCole Faust     if(framework::Framework::get().configure_only() && framework::Framework::get().new_fixture_call())
640*c217d954SCole Faust     {
641*c217d954SCole Faust         return true;
642*c217d954SCole Faust     }
643*c217d954SCole Faust 
644*c217d954SCole Faust     ARM_COMPUTE_TEST_INFO("reference = " << std::setprecision(5) << framework::make_printable(reference));
645*c217d954SCole Faust     ARM_COMPUTE_TEST_INFO("target = " << std::setprecision(5) << framework::make_printable(target));
646*c217d954SCole Faust     ARM_COMPUTE_TEST_INFO("tolerance = " << std::setprecision(5) << framework::make_printable(static_cast<typename U::value_type>(tolerance)));
647*c217d954SCole Faust 
648*c217d954SCole Faust     const bool equal = compare<U>(target, reference, tolerance);
649*c217d954SCole Faust 
650*c217d954SCole Faust     ARM_COMPUTE_EXPECT(equal, framework::LogLevel::ERRORS);
651*c217d954SCole Faust 
652*c217d954SCole Faust     return equal;
653*c217d954SCole Faust }
654*c217d954SCole Faust 
655*c217d954SCole Faust template <typename T, typename U>
656*c217d954SCole Faust void validate_min_max_loc(const MinMaxLocationValues<T> &target, const MinMaxLocationValues<U> &reference)
657*c217d954SCole Faust {
658*c217d954SCole Faust     if(framework::Framework::get().configure_only() && framework::Framework::get().new_fixture_call())
659*c217d954SCole Faust     {
660*c217d954SCole Faust         return;
661*c217d954SCole Faust     }
662*c217d954SCole Faust 
663*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(target.min, reference.min, framework::LogLevel::ERRORS);
664*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(target.max, reference.max, framework::LogLevel::ERRORS);
665*c217d954SCole Faust 
666*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(target.min_loc.size(), reference.min_loc.size(), framework::LogLevel::ERRORS);
667*c217d954SCole Faust     ARM_COMPUTE_EXPECT_EQUAL(target.max_loc.size(), reference.max_loc.size(), framework::LogLevel::ERRORS);
668*c217d954SCole Faust 
669*c217d954SCole Faust     for(uint32_t i = 0; i < target.min_loc.size(); ++i)
670*c217d954SCole Faust     {
671*c217d954SCole Faust         const auto same_coords = std::find_if(reference.min_loc.begin(), reference.min_loc.end(), [&target, i](Coordinates2D coord)
672*c217d954SCole Faust         {
673*c217d954SCole Faust             return coord.x == target.min_loc.at(i).x && coord.y == target.min_loc.at(i).y;
674*c217d954SCole Faust         });
675*c217d954SCole Faust 
676*c217d954SCole Faust         ARM_COMPUTE_EXPECT(same_coords != reference.min_loc.end(), framework::LogLevel::ERRORS);
677*c217d954SCole Faust     }
678*c217d954SCole Faust 
679*c217d954SCole Faust     for(uint32_t i = 0; i < target.max_loc.size(); ++i)
680*c217d954SCole Faust     {
681*c217d954SCole Faust         const auto same_coords = std::find_if(reference.max_loc.begin(), reference.max_loc.end(), [&target, i](Coordinates2D coord)
682*c217d954SCole Faust         {
683*c217d954SCole Faust             return coord.x == target.max_loc.at(i).x && coord.y == target.max_loc.at(i).y;
684*c217d954SCole Faust         });
685*c217d954SCole Faust 
686*c217d954SCole Faust         ARM_COMPUTE_EXPECT(same_coords != reference.max_loc.end(), framework::LogLevel::ERRORS);
687*c217d954SCole Faust     }
688*c217d954SCole Faust }
689*c217d954SCole Faust } // namespace validation
690*c217d954SCole Faust } // namespace test
691*c217d954SCole Faust } // namespace arm_compute
692*c217d954SCole Faust #endif /* ARM_COMPUTE_TEST_REFERENCE_VALIDATION_H */
693