11#ifndef EIGEN_NUMTRAITS_H
12#define EIGEN_NUMTRAITS_H
15#include "./InternalHeaderCheck.h"
23template <typename T, bool use_numeric_limits = std::numeric_limits<T>::is_specialized,
24 bool is_integer = NumTraits<T>::IsInteger>
25struct default_digits_impl {
26 EIGEN_DEVICE_FUNC
constexpr static int run() {
return std::numeric_limits<T>::digits; }
30struct default_digits_impl<T, false, false>
32 EIGEN_DEVICE_FUNC
constexpr static int run() {
35 using Real =
typename NumTraits<T>::Real;
36 return int(ceil(-log2(NumTraits<Real>::epsilon()))) + 1;
41struct default_digits_impl<T, false, true>
43 EIGEN_DEVICE_FUNC
constexpr static int run() {
return 0; }
46namespace precision_detail {
50template <
typename T,
typename =
void>
51struct has_epsilon_digits : std::false_type {};
55struct has_epsilon_digits<T, void_t<decltype(int(ceil(-log2(NumTraits<typename NumTraits<T>::Real>::epsilon()))) + 1)>>
60template <typename T, bool Known = std::numeric_limits<T>::is_specialized || NumTraits<T>::IsInteger ||
61 precision_detail::has_epsilon_digits<T>::value>
62struct decimal_digits_source {
63 EIGEN_DEVICE_FUNC
constexpr static int run() {
return default_digits_impl<T>::run(); }
67struct decimal_digits_source<T, false> {
68 EIGEN_DEVICE_FUNC
constexpr static int run() {
return 0; }
73template <typename T, bool use_numeric_limits = std::numeric_limits<T>::is_specialized,
74 bool is_integer = NumTraits<T>::IsInteger>
75struct default_digits10_impl {
76 EIGEN_DEVICE_FUNC
constexpr static int run() {
return std::numeric_limits<T>::digits10; }
80struct default_digits10_impl<T, false, false>
82 EIGEN_DEVICE_FUNC
constexpr static int run() {
85 using Real =
typename NumTraits<T>::Real;
86 const int digits = decimal_digits_source<Real>::run();
87 return digits > 0 ? int(floor((digits - 1) * log10(2))) : 0;
92struct default_digits10_impl<T, false, true>
94 EIGEN_DEVICE_FUNC
constexpr static int run() {
return 0; }
99template <typename T, bool use_numeric_limits = std::numeric_limits<T>::is_specialized,
100 bool is_integer = NumTraits<T>::IsInteger>
101struct default_max_digits10_impl {
102 EIGEN_DEVICE_FUNC
constexpr static int run() {
return std::numeric_limits<T>::max_digits10; }
106struct default_max_digits10_impl<T, false, false>
108 EIGEN_DEVICE_FUNC
constexpr static int run() {
111 using Real =
typename NumTraits<T>::Real;
112 const int digits = decimal_digits_source<Real>::run();
113 return digits > 0 ? int(ceil(digits * log10(2) + 1)) : 0;
118struct default_max_digits10_impl<T, false, true>
120 EIGEN_DEVICE_FUNC
constexpr static int run() {
return 0; }
130#if defined(__cpp_lib_bit_cast) && __cpp_lib_bit_cast >= 201806L && !defined(EIGEN_GPU_COMPILE_PHASE)
131template <
typename Tgt,
typename Src>
132EIGEN_DEVICE_FUNC
constexpr Tgt bit_cast(
const Src& src) {
133 return std::bit_cast<Tgt>(src);
135#elif EIGEN_HAS_BUILTIN(__builtin_bit_cast)
136template <
typename Tgt,
typename Src>
137EIGEN_DEVICE_FUNC
constexpr Tgt bit_cast(
const Src& src) {
138 EIGEN_STATIC_ASSERT(std::is_trivially_copyable<Src>::value, THIS_TYPE_IS_NOT_SUPPORTED)
139 EIGEN_STATIC_ASSERT(std::is_trivially_copyable<Tgt>::value, THIS_TYPE_IS_NOT_SUPPORTED)
140 EIGEN_STATIC_ASSERT(
sizeof(Src) ==
sizeof(Tgt), THIS_TYPE_IS_NOT_SUPPORTED)
141 return __builtin_bit_cast(Tgt, src);
144template <
typename Tgt,
typename Src>
145EIGEN_STRONG_INLINE EIGEN_DEVICE_FUNC Tgt bit_cast(
const Src& src) {
147 EIGEN_STATIC_ASSERT(std::is_trivially_copyable<Src>::value, THIS_TYPE_IS_NOT_SUPPORTED)
148 EIGEN_STATIC_ASSERT(std::is_trivially_copyable<Tgt>::value && std::is_default_constructible<Tgt>::value,
149 THIS_TYPE_IS_NOT_SUPPORTED)
150 EIGEN_STATIC_ASSERT(
sizeof(Src) ==
sizeof(Tgt), THIS_TYPE_IS_NOT_SUPPORTED)
154 const Src staged = src;
155 EIGEN_USING_STD(memcpy)
156 memcpy(
static_cast<void*
>(&tgt),
static_cast<const void*
>(&staged),
sizeof(Tgt));
224struct GenericNumTraits {
226 IsInteger = std::numeric_limits<T>::is_integer,
227 IsSigned = std::numeric_limits<T>::is_signed,
229 RequireInitialization = internal::is_arithmetic<T>::value ? 0 : 1,
236 using NonInteger = std::conditional_t<IsInteger, std::conditional_t<
sizeof(T) <= 2,
float,
double>, T>;
240 EIGEN_DEVICE_FUNC
constexpr static Real epsilon() {
return numext::numeric_limits<T>::epsilon(); }
242 EIGEN_DEVICE_FUNC
constexpr static int digits10() {
return internal::default_digits10_impl<T>::run(); }
244 EIGEN_DEVICE_FUNC
constexpr static int max_digits10() {
return internal::default_max_digits10_impl<T>::run(); }
246 EIGEN_DEVICE_FUNC
constexpr static int digits() {
return internal::default_digits_impl<T>::run(); }
248 EIGEN_DEVICE_FUNC
constexpr static int min_exponent() {
return numext::numeric_limits<T>::min_exponent; }
250 EIGEN_DEVICE_FUNC
constexpr static int max_exponent() {
return numext::numeric_limits<T>::max_exponent; }
252 EIGEN_DEVICE_FUNC
constexpr static Real dummy_precision() {
257 EIGEN_DEVICE_FUNC
constexpr static T highest() {
return (numext::numeric_limits<T>::max)(); }
259 EIGEN_DEVICE_FUNC
constexpr static T lowest() {
return (numext::numeric_limits<T>::lowest)(); }
261 EIGEN_DEVICE_FUNC
constexpr static T infinity() {
return numext::numeric_limits<T>::infinity(); }
263 EIGEN_DEVICE_FUNC
constexpr static T quiet_NaN() {
return numext::numeric_limits<T>::quiet_NaN(); }
270struct NumTraits<float> : GenericNumTraits<float> {
271 EIGEN_DEVICE_FUNC
constexpr static float dummy_precision() {
return 1e-5f; }
275struct NumTraits<double> : GenericNumTraits<double> {
276 EIGEN_DEVICE_FUNC
constexpr static double dummy_precision() {
return 1e-12; }
280#ifndef EIGEN_GPU_COMPILE_PHASE
282struct NumTraits<long double> : GenericNumTraits<long double> {
283 EIGEN_DEVICE_FUNC
constexpr static long double dummy_precision() {
return static_cast<long double>(1e-15l); }
285#if EIGEN_ARCH_PPC && (__LDBL_MANT_DIG__ == 106)
287 EIGEN_DEVICE_FUNC
constexpr static long double epsilon() {
289 return static_cast<long double>(2.4651903288156618919116517665087e-32l);
295template <
typename Real_>
296struct NumTraits<std::complex<Real_> > : GenericNumTraits<std::complex<Real_> > {
298 using Literal =
typename NumTraits<Real_>::Literal;
301 IsSigned = NumTraits<Real_>::IsSigned,
302 RequireInitialization = NumTraits<Real_>::RequireInitialization,
303 ReadCost = 2 * NumTraits<Real_>::ReadCost,
304 AddCost = 2 * NumTraits<Real>::AddCost,
305 MulCost = 4 * NumTraits<Real>::MulCost + 2 * NumTraits<Real>::AddCost
308 EIGEN_DEVICE_FUNC
constexpr static Real epsilon() {
return NumTraits<Real>::epsilon(); }
309 EIGEN_DEVICE_FUNC
constexpr static Real dummy_precision() {
return NumTraits<Real>::dummy_precision(); }
310 EIGEN_DEVICE_FUNC
constexpr static int digits10() {
return NumTraits<Real>::digits10(); }
311 EIGEN_DEVICE_FUNC
constexpr static int max_digits10() {
return NumTraits<Real>::max_digits10(); }
314template <
typename Scalar,
int Rows,
int Cols,
int Options,
int MaxRows,
int MaxCols>
315struct NumTraits<
Array<Scalar, Rows, Cols, Options, MaxRows, MaxCols> > {
316 using ArrayType = Array<Scalar, Rows, Cols, Options, MaxRows, MaxCols>;
317 using RealScalar =
typename NumTraits<Scalar>::Real;
318 using Real = Array<RealScalar, Rows, Cols, Options, MaxRows, MaxCols>;
319 using NonIntegerScalar =
typename NumTraits<Scalar>::NonInteger;
320 using NonInteger = Array<NonIntegerScalar, Rows, Cols, Options, MaxRows, MaxCols>;
321 using Nested = ArrayType&;
322 using Literal =
typename NumTraits<Scalar>::Literal;
325 IsComplex = NumTraits<Scalar>::IsComplex,
326 IsInteger = NumTraits<Scalar>::IsInteger,
327 IsSigned = NumTraits<Scalar>::IsSigned,
328 RequireInitialization = 1,
329 ReadCost = ArrayType::SizeAtCompileTime == Dynamic
331 : ArrayType::SizeAtCompileTime * int(NumTraits<Scalar>::ReadCost),
332 AddCost = ArrayType::SizeAtCompileTime == Dynamic ? HugeCost
333 : ArrayType::SizeAtCompileTime * int(NumTraits<Scalar>::AddCost),
334 MulCost = ArrayType::SizeAtCompileTime == Dynamic ? HugeCost
335 : ArrayType::SizeAtCompileTime * int(NumTraits<Scalar>::MulCost)
338 EIGEN_DEVICE_FUNC
constexpr static RealScalar epsilon() {
return NumTraits<RealScalar>::epsilon(); }
339 EIGEN_DEVICE_FUNC
constexpr static RealScalar dummy_precision() {
return NumTraits<RealScalar>::dummy_precision(); }
341 constexpr static int digits10() {
return NumTraits<Scalar>::digits10(); }
342 constexpr static int max_digits10() {
return NumTraits<Scalar>::max_digits10(); }
346struct NumTraits<std::string> : GenericNumTraits<std::string> {
347 enum { RequireInitialization = 1, ReadCost = HugeCost, AddCost = HugeCost, MulCost = HugeCost };
349 constexpr static int digits10() {
return 0; }
350 constexpr static int max_digits10() {
return 0; }
353 static inline std::string epsilon();
354 static inline std::string dummy_precision();
355 static inline std::string lowest();
356 static inline std::string highest();
357 static inline std::string infinity();
358 static inline std::string quiet_NaN();
366struct NumTraits<bool> : GenericNumTraits<bool> {};
General-purpose arrays with easy API for coefficient-wise operations.
Definition Array.h:55
Holds information about the various numeric (i.e. scalar) types allowed by Eigen.
Definition NumTraits.h:267