//***************************************************************************** // Copyright 2017-2018 Intel Corporation // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //***************************************************************************** #pragma once #include <memory> #include <vector> #include "test_tools.hpp" namespace ngraph { namespace test { /// \brief Determine distance between two f32 numbers /// \param a First number to compare /// \param b Second number to compare /// \returns Distance /// /// References: /// - https://en.wikipedia.org/wiki/Unit_in_the_last_place /// - https://randomascii.wordpress.com/2012/01/23/stupid-float-tricks-2 /// - https://github.com/google/googletest/blob/master/googletest/docs/AdvancedGuide.md#floating-point-comparison /// /// s e e e e e e e e m m m m m m m m m m m m m m m m m m m m m m m /// |------------bfloat-----------| /// |----------------------------float----------------------------| /// /// bfloat (s1, e8, m7) has 7 + 1 = 8 bits of mantissa or bit_precision /// float (s1, e8, m23) has 23 + 1 = 24 bits of mantissa or bit_precision /// /// This function uses hard-coded value of 8 bit exponent_bits, so it's only valid for /// bfloat and f32. uint32_t float_distance(float a, float b); /// \brief Check if the two f32 numbers are close /// \param a First number to compare /// \param b Second number to compare /// \param mantissa_bits The mantissa width of the underlying number before casting to float /// \param tolerance_bits Bit tolerance error /// \returns True iff the distance between a and b is within 2 ^ tolerance_bits ULP /// /// References: /// - https://en.wikipedia.org/wiki/Unit_in_the_last_place /// - https://randomascii.wordpress.com/2012/01/23/stupid-float-tricks-2 /// - https://github.com/google/googletest/blob/master/googletest/docs/AdvancedGuide.md#floating-point-comparison /// /// s e e e e e e e e m m m m m m m m m m m m m m m m m m m m m m m /// |------------bfloat-----------| /// |----------------------------float----------------------------| /// /// bfloat (s1, e8, m7) has 7 + 1 = 8 bits of mantissa or bit_precision /// float (s1, e8, m23) has 23 + 1 = 24 bits of mantissa or bit_precision /// /// This function uses hard-coded value of 8 bit exponent_bits, so it's only valid for /// bfloat and f32. bool close_f(float a, float b, int mantissa_bits = 8, int tolerance_bits = 2); /// \brief Determine distances between two vectors of f32 numbers /// \param a Vector of floats to compare /// \param b Vector of floats to compare /// \returns Vector of distances /// /// See float_distance for limitations and assumptions. std::vector<uint32_t> float_distances(const std::vector<float>& a, const std::vector<float>& b); /// \brief Determine number of matching mantissa bits given a distance /// \param distance Distance calculated by float_distance /// \returns Number of matching mantissa bits /// /// See float_distance for limitations and assumptions. uint32_t matching_mantissa_bits(uint32_t distance); /// \brief Check if the two floating point vectors are all close /// \param a First number to compare /// \param b Second number to compare /// \param mantissa_bits The mantissa width of the underlying number before casting to float /// \param tolerance_bits Bit tolerance error /// \returns true iff the two floating point vectors are close bool all_close_f(const std::vector<float>& a, const std::vector<float>& b, int mantissa_bits = 8, int tolerance_bits = 2); /// \brief Check if the two TensorViews are all close in float /// \param a First Tensor to compare /// \param b Second Tensor to compare /// \param mantissa_bits The mantissa width of the underlying number before casting to float /// \param tolerance_bits Bit tolerance error /// Returns true iff the two TensorViews are all close in float bool all_close_f(const std::shared_ptr<runtime::Tensor>& a, const std::shared_ptr<runtime::Tensor>& b, int mantissa_bits = 8, int tolerance_bits = 2); /// \brief Check if the two vectors of TensorViews are all close in float /// \param as First vector of Tensor to compare /// \param bs Second vector of Tensor to compare /// \param mantissa_bits The mantissa width of the underlying number before casting to float /// \param tolerance_bits Bit tolerance error /// Returns true iff the two TensorViews are all close in float bool all_close_f(const std::vector<std::shared_ptr<runtime::Tensor>>& as, const std::vector<std::shared_ptr<runtime::Tensor>>& bs, int mantissa_bits = 8, int tolerance_bits = 2); } }