num_util.h File Reference

Detailed Description

Declaration of numerical utility functions.

Date

Created on 7 Feb 2019

Copyright

Copyright 2019-2023 Deutsches Elektronen-Synchrotron (DESY), Hamburg

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.

#include <algorithm>
#include <cmath>
#include <limits>
#include <type_traits>
#include "gul17/internal.h"

Include dependency graph for num_util.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	gul17
	Namespace gul17 contains all functions and classes of the General Utility Library.

Functions
template<typename ValueT >
constexpr auto	gul17::abs (ValueT n) noexcept -> std::enable_if_t< std::is_unsigned< ValueT >::value, ValueT >
	Compute the absolute value of a number.
template<typename NumT , typename OrderT , typename = std::enable_if_t< std::is_arithmetic<NumT>::value and std::is_arithmetic<OrderT>::value >>
bool	gul17::within_orders (const NumT a, const NumT b, const OrderT orders) noexcept(false)
	Determine if two numbers are almost equal, comparing only some significant digits.
template<typename NumT >
bool	gul17::within_abs (NumT a, NumT b, NumT tol) noexcept
	Determine if two numbers are almost equal, allowing for an absolute difference.
template<typename NumT , typename = std::enable_if_t<std::is_floating_point<NumT>::value>>
bool	gul17::within_ulp (NumT a, NumT b, unsigned int ulp)
	Determine if two numbers are almost equal, allowing for a difference of a given number of units-in-the-last-place (ULPs).
template<class NumT >
constexpr const NumT &	gul17::clamp (const NumT &v, const NumT &lo, const NumT &hi)
	Coerce a value to be within a given range.
template<class NumT , class Compare >
constexpr const NumT &	gul17::clamp (const NumT &v, const NumT &lo, const NumT &hi, Compare comp)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.