#ifndef Magnum_Math_FunctionsBatch_h #define Magnum_Math_FunctionsBatch_h /* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 Vladimír Vondruš Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /** @file * @brief Batch functions usable with scalar and vector types */ #include #include #include "Magnum/Math/Functions.h" namespace Magnum { namespace Math { namespace Implementation { /** @todo Utility/Algorithms.h has a similar (but different) variant of this, maybe turn that into some public utility once we have one more use case? */ template::type>::from(std::declval()))> static auto stridedArrayViewTypeFor(T&&) -> typename View::Type; template static T stridedArrayViewTypeFor(const Corrade::Containers::ArrayView&); template static T stridedArrayViewTypeFor(const Corrade::Containers::StridedArrayView1D&); } /** @{ @name Batch functions These functions process an ubounded range of values, as opposed to single vectors or scalars. */ /** @brief If any number in the range is a positive or negative infinity For scalar types returns @cpp true @ce as soon as it finds an infinite value, @cpp false @ce otherwise. For vector types, returns @ref BitVector with bits set to @cpp 1 @ce if any value has that component infinite. If the range is empty, returns @cpp false @ce or a @ref BitVector with no bits set. @see @ref isInf(T), @ref Constants::inf() */ template auto isInf(const Corrade::Containers::StridedArrayView1D& range) -> decltype(isInf(std::declval())) { if(range.isEmpty()) return {}; /* For scalars, this loop exits once any value is infinity. For vectors the loop accumulates the bits and exits as soon as all bits are set or the input is exhausted */ auto out = isInf(range[0]); /* bool or BitVector */ for(std::size_t i = 1; i != range.size(); ++i) { if(out) break; out = out || isInf(range[i]); } return out; } /** @overload @m_since{2020,06} Converts @p range to @ref Corrade::Containers::StridedArrayView1D and calls the above overload. Works with any type that's convertible to @ref Corrade::Containers::StridedArrayView. */ template()))> inline auto isInf(Iterable&& range) -> decltype(isInf(std::declval())) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return isInf(Corrade::Containers::StridedArrayView1D{range}); } /** @overload */ template inline auto isInf(std::initializer_list list) -> decltype(isInf(std::declval())) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return isInf(Corrade::Containers::stridedArrayView(list)); } /** @overload */ template inline auto isInf(const T(&array)[size]) -> decltype(isInf(std::declval())) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return isInf(Corrade::Containers::StridedArrayView1D{array}); } /** @brief If any number in the range is a NaN For scalar types returns @cpp true @ce as soon as it finds a NaN value, @cpp false @ce otherwise. For vector types, returns @ref BitVector with bits set to @cpp 1 @ce if any value has that component NaN. If the range is empty, returns @cpp false @ce or a @ref BitVector with no bits set. @see @ref isNan(T), @ref Constants::nan() */ template inline auto isNan(const Corrade::Containers::StridedArrayView1D& range) -> decltype(isNan(std::declval())) { if(range.isEmpty()) return {}; /* For scalars, this loop exits once any value is infinity. For vectors the loop accumulates the bits and exits as soon as all bits are set or the input is exhausted */ auto out = isNan(range[0]); /* bool or BitVector */ for(std::size_t i = 1; i != range.size(); ++i) { if(out) break; out = out || isNan(range[i]); } return out; } /** @overload @m_since{2020,06} Converts @p range to @ref Corrade::Containers::StridedArrayView1D and calls the above overload. Works with any type that's convertible to @ref Corrade::Containers::StridedArrayView. */ /* See isInf() for why arrayView() and not stridedArrayView() */ template()))> inline auto isNan(Iterable&& range) -> decltype(isNan(std::declval())) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return isNan(Corrade::Containers::StridedArrayView1D{range}); } /** @overload */ template inline auto isNan(std::initializer_list list) -> decltype(isNan(std::declval())) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return isNan(Corrade::Containers::stridedArrayView(list)); } /** @overload */ template inline auto isNan(const T(&array)[size]) -> decltype(isNan(std::declval())) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return isNan(Corrade::Containers::StridedArrayView1D{array}); } namespace Implementation { /* Non-floating-point types, the first is a non-NaN for sure */ template constexpr std::pair firstNonNan(Corrade::Containers::StridedArrayView1D range, std::false_type, std::integral_constant) { return {0, range.front()}; } /* Floating-point scalars, return the first that's not NaN */ template inline std::pair firstNonNan(Corrade::Containers::StridedArrayView1D range, std::true_type, std::false_type) { /* Find the first non-NaN value to compare against. If all are NaN, return the last value so the following loop in min/max/minmax() doesn't even execute. */ for(std::size_t i = 0; i != range.size(); ++i) if(!isNan(range[i])) return {i, range[i]}; return {range.size() - 1, range.back()}; } /* Floating-point vectors. Try to gather non-NaN values for each component and exit as soon as all are found (or the input is exhausted). Return the index of first item with at least one non-NaN value as we need to go through all at least partially valid values again anyway in order to apply the min/max/minmax operation. I expect the cases of heavily NaN-filled vectors (and thus the need to loop twice through most of the range) to be very rare, so this shouldn't be a problem. */ template inline std::pair firstNonNan(Corrade::Containers::StridedArrayView1D range, std::true_type, std::true_type) { T out = range[0]; std::size_t firstValid = 0; for(std::size_t i = 1; i != range.size(); ++i) { BitVector nans = isNan(out); if(nans.none()) break; if(nans.all() && firstValid + 1 == i) ++firstValid; out = Math::lerp(out, range[i], isNan(out)); } return {firstValid, out}; } } /** @brief Minimum of a range If the range is empty, returns default-constructed value. NaNs are ignored, unless the range is all NaNs. @see @ref min(T, T), @ref isNan(const Corrade::Containers::StridedArrayView1D&) */ template inline T min(const Corrade::Containers::StridedArrayView1D& range) { if(range.isEmpty()) return {}; std::pair iOut = Implementation::firstNonNan(range, IsFloatingPoint{}, IsVector{}); for(++iOut.first; iOut.first != range.size(); ++iOut.first) iOut.second = Math::min(iOut.second, range[iOut.first]); return iOut.second; } /** @overload @m_since{2020,06} Converts @p range to @ref Corrade::Containers::StridedArrayView1D and calls the above overload. Works with any type that's convertible to @ref Corrade::Containers::StridedArrayView. */ template()))> inline T min(Iterable&& range) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return min(Corrade::Containers::StridedArrayView1D{range}); } /** @overload */ template inline T min(std::initializer_list list) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return min(Corrade::Containers::stridedArrayView(list)); } /** @overload */ template inline T min(const T(&array)[size]) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return min(Corrade::Containers::StridedArrayView1D{array}); } /** @brief Maximum of a range If the range is empty, returns default-constructed value. NaNs are ignored, unless the range is all NaNs. @see @ref max(T, T), @ref isNan(const Corrade::Containers::StridedArrayView1D&) */ template inline T max(const Corrade::Containers::StridedArrayView1D& range) { if(range.isEmpty()) return {}; std::pair iOut = Implementation::firstNonNan(range, IsFloatingPoint{}, IsVector{}); for(++iOut.first; iOut.first != range.size(); ++iOut.first) iOut.second = Math::max(iOut.second, range[iOut.first]); return iOut.second; } /** @overload @m_since{2020,06} Converts @p range to @ref Corrade::Containers::StridedArrayView1D and calls the above overload. Works with any type that's convertible to @ref Corrade::Containers::StridedArrayView. */ template()))> inline T max(Iterable&& range) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return max(Corrade::Containers::StridedArrayView1D{range}); } /** @overload */ template inline T max(std::initializer_list list) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return max(Corrade::Containers::stridedArrayView(list)); } /** @overload */ template inline T max(const T(&array)[size]) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return max(Corrade::Containers::StridedArrayView1D{array}); } namespace Implementation { template inline typename std::enable_if::value, void>::type minmax(T& min, T& max, T value) { if(value < min) min = value; else if(value > max) max = value; } template inline void minmax(Vector& min, Vector& max, const Vector& value) { for(std::size_t i = 0; i != size; ++i) minmax(min[i], max[i], value[i]); } } /** @brief Minimum and maximum of a range If the range is empty, returns default-constructed values. NaNs are ignored, unless the range is all NaNs. @see @ref minmax(T, T), @ref Range::Range(const std::pair&), @ref isNan(const Corrade::Containers::StridedArrayView1D&) */ template inline std::pair minmax(const Corrade::Containers::StridedArrayView1D& range) { if(range.isEmpty()) return {}; std::pair iOut = Implementation::firstNonNan(range, IsFloatingPoint{}, IsVector{}); T min{iOut.second}, max{iOut.second}; for(++iOut.first; iOut.first != range.size(); ++iOut.first) Implementation::minmax(min, max, range[iOut.first]); return {min, max}; } /** @overload @m_since{2020,06} Converts @p range to @ref Corrade::Containers::StridedArrayView1D and calls the above overload. Works with any type that's convertible to @ref Corrade::Containers::StridedArrayView. */ template()))> inline std::pair minmax(Iterable&& range) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return minmax(Corrade::Containers::StridedArrayView1D{range}); } /** @overload */ template inline std::pair minmax(std::initializer_list list) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return minmax(Corrade::Containers::stridedArrayView(list)); } /** @overload */ template inline std::pair minmax(const T(&array)[size]) { /* Specifying the template explicitly to avoid recursion into the generic function again */ return minmax(Corrade::Containers::StridedArrayView1D{array}); } /* Since 1.8.17, the original short-hand group closing doesn't work anymore. FFS. */ /** * @} */ }} #endif