Eigen  5.0.1
 
Loading...
Searching...
No Matches
GenericPacketMath.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
5// Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6//
7// This Source Code Form is subject to the terms of the Mozilla
8// Public License v. 2.0. If a copy of the MPL was not distributed
9// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10// SPDX-License-Identifier: MPL-2.0
11
12#ifndef EIGEN_GENERIC_PACKET_MATH_H
13#define EIGEN_GENERIC_PACKET_MATH_H
14
15// IWYU pragma: private
16#include "./InternalHeaderCheck.h"
17
18namespace Eigen {
19
20namespace internal {
21
29
30#ifndef EIGEN_DEBUG_ALIGNED_LOAD
31#define EIGEN_DEBUG_ALIGNED_LOAD
32#endif
33
34#ifndef EIGEN_DEBUG_UNALIGNED_LOAD
35#define EIGEN_DEBUG_UNALIGNED_LOAD
36#endif
37
38#ifndef EIGEN_DEBUG_ALIGNED_STORE
39#define EIGEN_DEBUG_ALIGNED_STORE
40#endif
41
42#ifndef EIGEN_DEBUG_UNALIGNED_STORE
43#define EIGEN_DEBUG_UNALIGNED_STORE
44#endif
45
46struct default_packet_traits {
47 enum {
48 // Ops that are implemented for most types.
49 HasAdd = 1,
50 HasSub = 1,
51 HasShift = 1,
52 HasMul = 1,
53 HasNegate = 1,
54 HasAbs = 1,
55 HasAbs2 = 1,
56 HasMin = 1,
57 HasMax = 1,
58 HasConj = 1,
59 HasSetLinear = 1,
60 HasSign = 1,
61 HasAbsDiff = 1,
62 // By default, the nearest integer functions (rint, round, floor, ceil, trunc) are enabled for all scalar and packet
63 // types
64 HasRound = 1,
65
66 HasArg = 0,
67 // This flag is used to indicate whether packet comparison is supported.
68 // pcmp_eq and pcmp_lt should be defined for it to be true.
69 HasCmp = 0,
70
71 HasDiv = 0,
72 HasReciprocal = 0,
73 HasSqrt = 0,
74 HasRsqrt = 0,
75 HasCbrt = 0,
76 HasExp = 0,
77 HasExpm1 = 0,
78 HasLog = 0,
79 HasLog1p = 0,
80 HasLog10 = 0,
81 HasPow = 0,
82 HasSin = 0,
83 HasCos = 0,
84 HasTan = 0,
85 HasASin = 0,
86 HasACos = 0,
87 HasATan = 0,
88 HasATanh = 0,
89 HasSinh = 0,
90 HasCosh = 0,
91 HasASinh = 0,
92 HasACosh = 0,
93 HasTanh = 0,
94 HasLGamma = 0,
95 HasDiGamma = 0,
96 HasZeta = 0,
97 HasPolygamma = 0,
98 HasErf = 0,
99 HasErfc = 0,
100 HasNdtri = 0,
101 HasBessel = 0,
102 HasIGamma = 0,
103 HasIGammaDerA = 0,
104 HasGammaSampleDerAlpha = 0,
105 HasIGammac = 0,
106 HasBetaInc = 0
107 };
108};
109
110template <typename T>
111struct packet_traits : default_packet_traits {
112 using type = T;
113 using half = T;
114 enum {
115 Vectorizable = 0,
116 size = 1,
117 AlignedOnScalar = 0,
118 };
119 enum {
120 HasAdd = 0,
121 HasSub = 0,
122 HasAbsDiff = 0,
123 HasMul = 0,
124 HasNegate = 0,
125 HasAbs = 0,
126 HasAbs2 = 0,
127 HasMin = 0,
128 HasMax = 0,
129 HasConj = 0,
130 HasSetLinear = 0
131 };
132};
133
134template <typename T>
135struct packet_traits<const T> : packet_traits<T> {};
136
137struct default_unpacket_traits {
138 enum { vectorizable = false, masked_load_available = false, masked_store_available = false };
139};
140
141template <typename T>
142struct unpacket_traits : default_unpacket_traits {
143 using type = T;
144 using half = T;
145 using integer_packet = typename numext::get_integer_by_size<sizeof(T)>::signed_type;
146 enum {
147 size = 1,
148 alignment = alignof(T),
149 };
150};
151
152template <typename T>
153struct unpacket_traits<const T> : unpacket_traits<T> {};
154
158template <typename Packet>
159struct is_scalar : std::is_same<Packet, typename unpacket_traits<Packet>::type> {};
160
161// automatically and succinctly define combinations of pcast<SrcPacket,TgtPacket> when
162// 1) the packets are the same type, or
163// 2) the packets differ only in sign.
164// In both of these cases, preinterpret (bit_cast) is equivalent to pcast (static_cast)
165template <typename SrcPacket, typename TgtPacket,
166 bool Scalar = is_scalar<SrcPacket>::value && is_scalar<TgtPacket>::value>
167struct is_degenerate_helper : std::is_same<SrcPacket, TgtPacket> {};
168template <>
169struct is_degenerate_helper<int8_t, uint8_t, true> : std::true_type {};
170template <>
171struct is_degenerate_helper<int16_t, uint16_t, true> : std::true_type {};
172template <>
173struct is_degenerate_helper<int32_t, uint32_t, true> : std::true_type {};
174template <>
175struct is_degenerate_helper<int64_t, uint64_t, true> : std::true_type {};
176
177template <typename SrcPacket, typename TgtPacket>
178struct is_degenerate_helper<SrcPacket, TgtPacket, false> {
179 using SrcScalar = typename unpacket_traits<SrcPacket>::type;
180 static constexpr int SrcSize = unpacket_traits<SrcPacket>::size;
181 using TgtScalar = typename unpacket_traits<TgtPacket>::type;
182 static constexpr int TgtSize = unpacket_traits<TgtPacket>::size;
183 static constexpr bool value = is_degenerate_helper<SrcScalar, TgtScalar, true>::value && (SrcSize == TgtSize);
184};
185
186// is_degenerate<T1,T2>::value == is_degenerate<T2,T1>::value
187template <typename SrcPacket, typename TgtPacket>
188struct is_degenerate {
189 static constexpr bool value =
190 is_degenerate_helper<SrcPacket, TgtPacket>::value || is_degenerate_helper<TgtPacket, SrcPacket>::value;
191};
192
193template <typename Packet>
194struct is_half {
195 using Scalar = typename unpacket_traits<Packet>::type;
196 static constexpr int Size = unpacket_traits<Packet>::size;
197 using DefaultPacket = typename packet_traits<Scalar>::type;
198 static constexpr int DefaultSize = unpacket_traits<DefaultPacket>::size;
199 static constexpr bool value = Size != 1 && Size < DefaultSize;
200};
201
202template <typename Src, typename Tgt>
203struct type_casting_traits {
204 enum {
205 VectorizedCast =
206 is_degenerate<Src, Tgt>::value && packet_traits<Src>::Vectorizable && packet_traits<Tgt>::Vectorizable,
207 SrcCoeffRatio = 1,
208 TgtCoeffRatio = 1
209 };
210};
211
212// provides a succinct template to define vectorized casting traits with respect to the largest accessible packet types
213template <typename Src, typename Tgt>
214struct vectorized_type_casting_traits {
215 enum : int {
216 DefaultSrcPacketSize = packet_traits<Src>::size,
217 DefaultTgtPacketSize = packet_traits<Tgt>::size,
218 VectorizedCast = 1,
219 SrcCoeffRatio = plain_enum_max(DefaultTgtPacketSize / DefaultSrcPacketSize, 1),
220 TgtCoeffRatio = plain_enum_max(DefaultSrcPacketSize / DefaultTgtPacketSize, 1)
221 };
222};
223
226template <typename T, int unique_id = 0>
227struct eigen_packet_wrapper {
228 EIGEN_ALWAYS_INLINE operator T&() { return m_val; }
229 EIGEN_ALWAYS_INLINE operator const T&() const { return m_val; }
230 EIGEN_ALWAYS_INLINE eigen_packet_wrapper() = default;
231 EIGEN_ALWAYS_INLINE eigen_packet_wrapper(const T& v) : m_val(v) {}
232 EIGEN_ALWAYS_INLINE eigen_packet_wrapper& operator=(const T& v) {
233 m_val = v;
234 return *this;
235 }
236
237 T m_val;
238};
239
240template <typename Target, typename Packet, bool IsSame = std::is_same<Target, Packet>::value>
241struct preinterpret_generic;
242
243template <typename Target, typename Packet>
244struct preinterpret_generic<Target, Packet, false> {
245 // the packets are not the same, attempt scalar bit_cast
246 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Target run(const Packet& a) {
247 return numext::bit_cast<Target, Packet>(a);
248 }
249};
250
251template <typename Packet>
252struct preinterpret_generic<Packet, Packet, true> {
253 // the packets are the same type: do nothing
254 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet run(const Packet& a) { return a; }
255};
256
257template <typename ComplexPacket>
258struct preinterpret_generic<typename unpacket_traits<ComplexPacket>::as_real, ComplexPacket, false> {
259 using RealPacket = typename unpacket_traits<ComplexPacket>::as_real;
260 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE RealPacket run(const ComplexPacket& a) { return a.v; }
261};
262
264template <typename Target, typename Packet>
265EIGEN_DEVICE_FUNC inline Target preinterpret(const Packet& a) {
266 return preinterpret_generic<Target, Packet>::run(a);
267}
268
269template <typename SrcPacket, typename TgtPacket, bool Degenerate = is_degenerate<SrcPacket, TgtPacket>::value,
270 bool TgtIsHalf = is_half<TgtPacket>::value>
271struct pcast_generic;
272
273template <typename SrcPacket, typename TgtPacket>
274struct pcast_generic<SrcPacket, TgtPacket, false, false> {
275 // the packets are not degenerate: attempt scalar static_cast
276 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TgtPacket run(const SrcPacket& a) {
277 return cast_impl<SrcPacket, TgtPacket>::run(a);
278 }
279};
280
281template <typename Packet>
282struct pcast_generic<Packet, Packet, true, false> {
283 // the packets are the same: do nothing
284 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet run(const Packet& a) { return a; }
285};
286
287template <typename SrcPacket, typename TgtPacket, bool TgtIsHalf>
288struct pcast_generic<SrcPacket, TgtPacket, true, TgtIsHalf> {
289 // the packets are degenerate: preinterpret is equivalent to pcast
290 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TgtPacket run(const SrcPacket& a) { return preinterpret<TgtPacket>(a); }
291};
292
294template <typename SrcPacket, typename TgtPacket>
295EIGEN_DEVICE_FUNC inline TgtPacket pcast(const SrcPacket& a) {
296 return pcast_generic<SrcPacket, TgtPacket>::run(a);
297}
298template <typename SrcPacket, typename TgtPacket>
299EIGEN_DEVICE_FUNC inline TgtPacket pcast(const SrcPacket& a, const SrcPacket& b) {
300 return pcast_generic<SrcPacket, TgtPacket>::run(a, b);
301}
302template <typename SrcPacket, typename TgtPacket>
303EIGEN_DEVICE_FUNC inline TgtPacket pcast(const SrcPacket& a, const SrcPacket& b, const SrcPacket& c,
304 const SrcPacket& d) {
305 return pcast_generic<SrcPacket, TgtPacket>::run(a, b, c, d);
306}
307template <typename SrcPacket, typename TgtPacket>
308EIGEN_DEVICE_FUNC inline TgtPacket pcast(const SrcPacket& a, const SrcPacket& b, const SrcPacket& c, const SrcPacket& d,
309 const SrcPacket& e, const SrcPacket& f, const SrcPacket& g,
310 const SrcPacket& h) {
311 return pcast_generic<SrcPacket, TgtPacket>::run(a, b, c, d, e, f, g, h);
312}
313
314template <typename SrcPacket, typename TgtPacket>
315struct pcast_generic<SrcPacket, TgtPacket, false, true> {
316 // TgtPacket is a half packet of some other type
317 // perform cast and truncate result
318 using DefaultTgtPacket = typename is_half<TgtPacket>::DefaultPacket;
319 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE TgtPacket run(const SrcPacket& a) {
320 return preinterpret<TgtPacket>(pcast<SrcPacket, DefaultTgtPacket>(a));
321 }
322};
323
325template <typename Packet>
326EIGEN_DEVICE_FUNC inline Packet padd(const Packet& a, const Packet& b) {
327 return a + b;
328}
329// Bool arithmetic is specialized to avoid compiler warnings. Bitwise operations are intentional to keep scalar
330// evaluator loops branch-free.
331template <>
332EIGEN_DEVICE_FUNC inline bool padd(const bool& a, const bool& b) {
333 return a | b;
334}
335
340template <typename Packet>
341EIGEN_DEVICE_FUNC inline std::enable_if_t<unpacket_traits<Packet>::masked_fpops_available, Packet> padd(
342 const Packet& a, const Packet& b, typename unpacket_traits<Packet>::mask_t umask);
343
345template <typename Packet>
346EIGEN_DEVICE_FUNC inline Packet psub(const Packet& a, const Packet& b) {
347 return a - b;
348}
349
351template <typename Packet>
352EIGEN_DEVICE_FUNC inline Packet pnegate(const Packet& a) {
353 EIGEN_STATIC_ASSERT((!std::is_same<typename unpacket_traits<Packet>::type, bool>::value),
354 NEGATE IS NOT DEFINED FOR BOOLEAN TYPES)
355 return numext::negate(a);
356}
357
359template <typename Packet>
360EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet pconj(const Packet& a) {
361 using Scalar = typename unpacket_traits<Packet>::type;
362 EIGEN_IF_CONSTEXPR (NumTraits<Scalar>::IsComplex)
363 return numext::conj(a);
364 else
365 return a;
366}
367
369template <typename Packet>
370EIGEN_DEVICE_FUNC inline Packet pmul(const Packet& a, const Packet& b) {
371 return internal::mul(a, b);
372}
373template <>
374EIGEN_DEVICE_FUNC inline bool pmul(const bool& a, const bool& b) {
375 return a & b;
376}
377
379template <typename Packet>
380EIGEN_DEVICE_FUNC inline Packet pdiv(const Packet& a, const Packet& b) {
381 return a / b;
382}
383template <>
384EIGEN_DEVICE_FUNC inline bool pdiv(const bool& a, const bool& b) {
385 return a & b;
386}
387
388// In the generic packet case, memset to all one bits.
389template <typename Packet, typename EnableIf = void>
390struct ptrue_impl {
391 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& /*a*/) {
392 Packet b;
393 memset(static_cast<void*>(&b), 0xff, sizeof(Packet));
394 return b;
395 }
396};
397
398// Use a value of one for scalars.
399template <typename Scalar>
400struct ptrue_impl<Scalar, std::enable_if_t<is_scalar<Scalar>::value>> {
401 static EIGEN_DEVICE_FUNC inline Scalar run(const Scalar&) { return Scalar(1); }
402};
403
404// For booleans, we can only directly set a valid `bool` value to avoid UB.
405template <>
406struct ptrue_impl<bool, void> {
407 static EIGEN_DEVICE_FUNC inline bool run(const bool&) { return true; }
408};
409
410// The all-ones value of a floating-point packet is a NaN bit pattern, which fast-math builds
411// may fold to poison; see EIGEN_FAST_MATH_CONSTANT_BARRIER in Macros.h. The same applies to
412// peven_mask, pinf and pnan below.
414template <typename Packet>
415EIGEN_DEVICE_FUNC inline Packet ptrue(const Packet& a) {
416 if (is_scalar<Packet>::value || std::is_same<Packet, bool>::value) {
417 // Scalar and boolean "masks" hold the value one, which is a legal value class; delegating
418 // to ptrue_impl (and its specializations) is safe here.
419 return ptrue_impl<Packet>::run(a);
420 }
421 Packet b;
422 memset(static_cast<void*>(&b), 0xff, sizeof(Packet));
423 EIGEN_FAST_MATH_CONSTANT_BARRIER(b);
424 return b;
425}
426
427// In the general packet case, memset to zero.
428template <typename Packet, typename EnableIf = void>
429struct pzero_impl {
430 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& /*a*/) {
431 Packet b;
432 memset(static_cast<void*>(&b), 0x00, sizeof(Packet));
433 return b;
434 }
435};
436
437// For scalars, explicitly set to Scalar(0), since the underlying representation
438// for zero may not consist of all-zero bits.
439template <typename T>
440struct pzero_impl<T, std::enable_if_t<is_scalar<T>::value>> {
441 static EIGEN_DEVICE_FUNC inline T run(const T& /*a*/) { return T(0); }
442};
443
445template <typename Packet>
446EIGEN_DEVICE_FUNC inline Packet pzero(const Packet& a) {
447 return pzero_impl<Packet>::run(a);
448}
449
450template <typename T>
451struct bit_and {
452 EIGEN_DEVICE_FUNC constexpr EIGEN_ALWAYS_INLINE T operator()(const T& a, const T& b) const { return a & b; }
453};
454
455template <typename T>
456struct bit_or {
457 EIGEN_DEVICE_FUNC constexpr EIGEN_ALWAYS_INLINE T operator()(const T& a, const T& b) const { return a | b; }
458};
459
460template <typename T>
461struct bit_xor {
462 EIGEN_DEVICE_FUNC constexpr EIGEN_ALWAYS_INLINE T operator()(const T& a, const T& b) const { return a ^ b; }
463};
464
465template <typename T>
466struct bit_not {
467 EIGEN_DEVICE_FUNC constexpr EIGEN_ALWAYS_INLINE T operator()(const T& a) const { return ~a; }
468};
469
470template <>
471struct bit_and<bool> {
472 EIGEN_DEVICE_FUNC constexpr EIGEN_ALWAYS_INLINE bool operator()(const bool& a, const bool& b) const { return a & b; }
473};
474
475template <>
476struct bit_or<bool> {
477 EIGEN_DEVICE_FUNC constexpr EIGEN_ALWAYS_INLINE bool operator()(const bool& a, const bool& b) const { return a | b; }
478};
479
480template <>
481struct bit_xor<bool> {
482 EIGEN_DEVICE_FUNC constexpr EIGEN_ALWAYS_INLINE bool operator()(const bool& a, const bool& b) const { return a != b; }
483};
484
485template <>
486struct bit_not<bool> {
487 EIGEN_DEVICE_FUNC constexpr EIGEN_ALWAYS_INLINE bool operator()(const bool& a) const { return !a; }
488};
489
490// Use operators &, |, ^, ~.
491template <typename T>
492struct operator_bitwise_helper {
493 EIGEN_DEVICE_FUNC static inline T bitwise_and(const T& a, const T& b) { return bit_and<T>()(a, b); }
494 EIGEN_DEVICE_FUNC static inline T bitwise_or(const T& a, const T& b) { return bit_or<T>()(a, b); }
495 EIGEN_DEVICE_FUNC static inline T bitwise_xor(const T& a, const T& b) { return bit_xor<T>()(a, b); }
496 EIGEN_DEVICE_FUNC static inline T bitwise_not(const T& a) { return bit_not<T>()(a); }
497};
498
499// Apply binary operations byte-by-byte
500template <typename T>
501struct bytewise_bitwise_helper {
502 EIGEN_DEVICE_FUNC static inline T bitwise_and(const T& a, const T& b) {
503 return binary(a, b, bit_and<unsigned char>());
504 }
505 EIGEN_DEVICE_FUNC static inline T bitwise_or(const T& a, const T& b) { return binary(a, b, bit_or<unsigned char>()); }
506 EIGEN_DEVICE_FUNC static inline T bitwise_xor(const T& a, const T& b) {
507 return binary(a, b, bit_xor<unsigned char>());
508 }
509 EIGEN_DEVICE_FUNC static inline T bitwise_not(const T& a) { return unary(a, bit_not<unsigned char>()); }
510
511 private:
512 template <typename Op>
513 EIGEN_DEVICE_FUNC static inline T unary(const T& a, Op op) {
514 const unsigned char* a_ptr = reinterpret_cast<const unsigned char*>(&a);
515 T c;
516 unsigned char* c_ptr = reinterpret_cast<unsigned char*>(&c);
517 for (size_t i = 0; i < sizeof(T); ++i) {
518 *c_ptr++ = op(*a_ptr++);
519 }
520 return c;
521 }
522
523 template <typename Op>
524 EIGEN_DEVICE_FUNC static inline T binary(const T& a, const T& b, Op op) {
525 const unsigned char* a_ptr = reinterpret_cast<const unsigned char*>(&a);
526 const unsigned char* b_ptr = reinterpret_cast<const unsigned char*>(&b);
527 T c;
528 unsigned char* c_ptr = reinterpret_cast<unsigned char*>(&c);
529 for (size_t i = 0; i < sizeof(T); ++i) {
530 *c_ptr++ = op(*a_ptr++, *b_ptr++);
531 }
532 return c;
533 }
534};
535
536// In the general case, use byte-by-byte manipulation.
537template <typename T, typename EnableIf = void>
538struct bitwise_helper : public bytewise_bitwise_helper<T> {};
539
540// For integers or non-trivial scalars, use binary operators.
541template <typename T>
542struct bitwise_helper<
543 T, std::enable_if_t<is_scalar<T>::value && (NumTraits<T>::IsInteger || NumTraits<T>::RequireInitialization)>>
544 : public operator_bitwise_helper<T> {};
545
547template <typename Packet>
548EIGEN_DEVICE_FUNC inline Packet pand(const Packet& a, const Packet& b) {
549 return bitwise_helper<Packet>::bitwise_and(a, b);
550}
551
553template <typename Packet>
554EIGEN_DEVICE_FUNC inline Packet por(const Packet& a, const Packet& b) {
555 return bitwise_helper<Packet>::bitwise_or(a, b);
556}
557
559template <typename Packet>
560EIGEN_DEVICE_FUNC inline Packet pxor(const Packet& a, const Packet& b) {
561 return bitwise_helper<Packet>::bitwise_xor(a, b);
562}
563
565template <typename Packet>
566EIGEN_DEVICE_FUNC inline Packet pnot(const Packet& a) {
567 return bitwise_helper<Packet>::bitwise_not(a);
568}
569
571template <typename Packet>
572EIGEN_DEVICE_FUNC inline Packet pandnot(const Packet& a, const Packet& b) {
573 return pand(a, pnot(b));
574}
575
577template <typename Packet>
578EIGEN_DEVICE_FUNC inline Packet pcmp_lt(const Packet& a, const Packet& b) {
579 return a < b ? ptrue(a) : pzero(a);
580}
581
583template <typename Packet>
584EIGEN_DEVICE_FUNC inline Packet pcmp_eq(const Packet& a, const Packet& b) {
585 return a == b ? ptrue(a) : pzero(a);
586}
587
589template <typename Packet>
590EIGEN_DEVICE_FUNC inline Packet pcmp_le(const Packet& a, const Packet& b) {
591 return por(pcmp_eq(a, b), pcmp_lt(a, b));
592}
593
595template <typename Packet>
596EIGEN_DEVICE_FUNC inline Packet pcmp_lt_or_nan(const Packet& a, const Packet& b) {
597 return a >= b ? pzero(a) : ptrue(a);
598}
599
600// In the general case, use bitwise select.
601template <typename Packet, bool is_scalar = is_scalar<Packet>::value>
602struct pselect_impl {
603 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& mask, const Packet& a, const Packet& b) {
604 return por(pand(a, mask), pandnot(b, mask));
605 }
606};
607
608// For scalars, use ternary select.
609template <typename Packet>
610struct pselect_impl<Packet, true> {
611 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& mask, const Packet& a, const Packet& b) {
612 return numext::select(mask, a, b);
613 }
614};
615
617template <typename Packet>
618EIGEN_DEVICE_FUNC inline Packet pselect(const Packet& mask, const Packet& a, const Packet& b) {
619 return pselect_impl<Packet>::run(mask, a, b);
620}
621
622template <>
623EIGEN_DEVICE_FUNC inline bool pselect<bool>(const bool& cond, const bool& a, const bool& b) {
624 return cond ? a : b;
625}
626
628template <typename Packet>
629struct pminmax_propagates_nan : bool_constant<false> {};
630
635template <int NaNPropagation, bool IsInteger, bool NativePropagatesNaN = false>
636struct pminmax_impl {
637 template <typename Packet, typename Op>
638 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a, const Packet& b, Op op) {
639 return op(a, b);
640 }
641};
642
645template <>
646struct pminmax_impl<PropagateNaN, false, false> {
647 template <typename Packet, typename Op>
648 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a, const Packet& b, Op op) {
649 // pselect is an ordinary call, so op(a, b) is evaluated even where an operand is NaN;
650 // only its result is discarded there. op therefore need not propagate NaN, but must
651 // still be well-defined on NaN input. Operands stay in the caller's order so that op
652 // selects the same one on a signed-zero tie as plain pmin/pmax does for this Packet.
653 Packet not_nan_mask_a = pcmp_eq(a, a);
654 Packet not_nan_mask_b = pcmp_eq(b, b);
655 return pselect(not_nan_mask_a, pselect(not_nan_mask_b, op(a, b), b), a);
656 }
657};
658
662template <bool NativePropagatesNaN>
663struct pminmax_impl<PropagateNumbers, false, NativePropagatesNaN> {
664 template <typename Packet, typename Op>
665 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a, const Packet& b, Op op) {
666 Packet not_nan_mask_a = pcmp_eq(a, a);
667 Packet not_nan_mask_b = pcmp_eq(b, b);
668 return pselect(not_nan_mask_a, pselect(not_nan_mask_b, op(a, b), a), b);
669 }
670};
671
672#define EIGEN_BINARY_OP_NAN_PROPAGATION(Type, Func) [](const Type& aa, const Type& bb) { return Func(aa, bb); }
673
676template <typename Packet>
677EIGEN_DEVICE_FUNC inline Packet pmin(const Packet& a, const Packet& b) {
678 return numext::mini(a, b);
679}
680
683template <int NaNPropagation, typename Packet>
684EIGEN_DEVICE_FUNC inline Packet pmin(const Packet& a, const Packet& b) {
685 constexpr bool IsInteger = NumTraits<typename unpacket_traits<Packet>::type>::IsInteger;
686 constexpr bool NativePropagatesNaN = pminmax_propagates_nan<Packet>::value;
687 return pminmax_impl<NaNPropagation, IsInteger, NativePropagatesNaN>::run(
688 a, b, EIGEN_BINARY_OP_NAN_PROPAGATION(Packet, (pmin<Packet>)));
689}
690
693template <typename Packet>
694EIGEN_DEVICE_FUNC inline Packet pmax(const Packet& a, const Packet& b) {
695 return numext::maxi(a, b);
696}
697
700template <int NaNPropagation, typename Packet>
701EIGEN_DEVICE_FUNC inline Packet pmax(const Packet& a, const Packet& b) {
702 constexpr bool IsInteger = NumTraits<typename unpacket_traits<Packet>::type>::IsInteger;
703 constexpr bool NativePropagatesNaN = pminmax_propagates_nan<Packet>::value;
704 return pminmax_impl<NaNPropagation, IsInteger, NativePropagatesNaN>::run(
705 a, b, EIGEN_BINARY_OP_NAN_PROPAGATION(Packet, (pmax<Packet>)));
706}
707
709template <typename Packet, std::enable_if_t<!(NumTraits<typename unpacket_traits<Packet>::type>::IsInteger &&
710 !NumTraits<typename unpacket_traits<Packet>::type>::IsSigned),
711 int> = 0>
712EIGEN_DEVICE_FUNC inline Packet pabs(const Packet& a) {
713 return numext::abs(a);
714}
715
716template <typename Packet, std::enable_if_t<NumTraits<typename unpacket_traits<Packet>::type>::IsInteger &&
717 !NumTraits<typename unpacket_traits<Packet>::type>::IsSigned,
718 int> = 0>
719EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet pabs(const Packet& a) {
720 return a;
721}
722
724template <typename Packet>
725EIGEN_DEVICE_FUNC inline Packet paddsub(const Packet& a, const Packet& b) {
726 return pselect(peven_mask(a), padd(a, b), psub(a, b));
727}
728
730template <typename Packet>
731EIGEN_DEVICE_FUNC inline Packet parg(const Packet& a) {
732 using numext::arg;
733 return arg(a);
734}
735
737template <int N, typename T>
738EIGEN_DEVICE_FUNC inline T parithmetic_shift_right(const T& a) {
739 return numext::arithmetic_shift_right(a, N);
740}
741
743template <int N, typename T>
744EIGEN_DEVICE_FUNC inline T plogical_shift_right(const T& a) {
745 return numext::logical_shift_right(a, N);
746}
747
749template <int N, typename T>
750EIGEN_DEVICE_FUNC inline T plogical_shift_left(const T& a) {
751 return numext::logical_shift_left(a, N);
752}
753
757template <typename Packet>
758EIGEN_DEVICE_FUNC inline Packet pfrexp(const Packet& a, Packet& exponent) {
759 int exp;
760 EIGEN_USING_STD(frexp);
761 Packet result = static_cast<Packet>(frexp(a, &exp));
762 exponent = static_cast<Packet>(exp);
763 return result;
764}
765
769template <typename Packet>
770EIGEN_DEVICE_FUNC inline Packet pldexp(const Packet& a, const Packet& exponent) {
771 EIGEN_USING_STD(ldexp)
772 return static_cast<Packet>(ldexp(a, static_cast<int>(exponent)));
773}
774
776template <typename Packet>
777EIGEN_DEVICE_FUNC inline std::enable_if_t<NumTraits<typename unpacket_traits<Packet>::type>::IsInteger, Packet>
778pabsdiff(const Packet& a, const Packet& b) {
779 return pselect(pcmp_lt(a, b), psub(b, a), psub(a, b));
780}
781template <typename Packet>
782EIGEN_DEVICE_FUNC inline std::enable_if_t<!NumTraits<typename unpacket_traits<Packet>::type>::IsInteger, Packet>
783pabsdiff(const Packet& a, const Packet& b) {
784 return pabs(psub(a, b));
785}
786
788template <typename Packet>
789EIGEN_DEVICE_FUNC inline Packet pload(const typename unpacket_traits<Packet>::type* from) {
790 return *from;
791}
792
797template <typename Packet>
798EIGEN_DEVICE_FUNC inline Packet pload_partial(const typename unpacket_traits<Packet>::type* from, const Index n,
799 const Index offset = 0) {
800 const Index packet_size = unpacket_traits<Packet>::size;
801 eigen_assert(n + offset <= packet_size && "number of elements plus offset will read past end of packet");
802 using Scalar = typename unpacket_traits<Packet>::type;
803 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) Scalar elements[packet_size] = {Scalar(0)};
804 for (Index i = offset; i < numext::mini(n + offset, packet_size); i++) {
805 elements[i] = from[i - offset];
806 }
807 return pload<Packet>(elements);
808}
809
811template <typename Packet>
812EIGEN_DEVICE_FUNC inline Packet ploadu(const typename unpacket_traits<Packet>::type* from) {
813 return *from;
814}
815
818template <typename Packet>
819EIGEN_DEVICE_FUNC inline Packet ploadu_partial(const typename unpacket_traits<Packet>::type* from, const Index n,
820 const Index offset = 0) {
821 const Index packet_size = unpacket_traits<Packet>::size;
822 eigen_assert(n + offset <= packet_size && "number of elements plus offset will read past end of packet");
823 using Scalar = typename unpacket_traits<Packet>::type;
824 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) Scalar elements[packet_size] = {Scalar(0)};
825 for (Index i = offset; i < numext::mini(n + offset, packet_size); i++) {
826 elements[i] = from[i - offset];
827 }
828 return pload<Packet>(elements);
829}
830
835template <typename Packet>
836EIGEN_DEVICE_FUNC inline std::enable_if_t<unpacket_traits<Packet>::masked_load_available, Packet> ploadu(
837 const typename unpacket_traits<Packet>::type* from, typename unpacket_traits<Packet>::mask_t umask);
838
840template <typename Packet>
841EIGEN_DEVICE_FUNC inline Packet pset1(const typename unpacket_traits<Packet>::type& a) {
842 return a;
843}
844
846template <typename Packet, typename BitsType>
847EIGEN_DEVICE_FUNC inline Packet pset1frombits(BitsType a) {
848 using Scalar = typename unpacket_traits<Packet>::type;
849 return pset1<Packet>(numext::bit_cast<Scalar>(a));
850}
851
852template <typename Packet>
853struct packet_bit_pattern_traits {
854 using Scalar = typename unpacket_traits<Packet>::type;
855 using Bits = typename numext::get_integer_by_size<sizeof(Scalar)>::unsigned_type;
856 enum { HasIntegerBits = !std::is_void<Bits>::value };
857};
858
859// Widening an opaque IEEE binary32 bit pattern produces the target's native extended-scalar representation without
860// exposing a floating-point special-value literal to fast-math optimizers.
861template <typename Scalar>
862EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Scalar pscalar_from_float_bits(numext::uint32_t bits) {
863#if EIGEN_COMP_GNUC_STRICT && defined(__FINITE_MATH_ONLY__) && __FINITE_MATH_ONLY__ && \
864 !defined(EIGEN_GPU_COMPILE_PHASE) && !defined(SYCL_DEVICE_ONLY)
865 // GCC also needs the integer pattern hidden before bit_cast and widening. Use a memory operand so this works on
866 // targets where EIGEN_OPTIMIZATION_BARRIER is intentionally unavailable.
867 __asm__("" : "+m"(bits));
868#endif
869 EIGEN_FAST_MATH_CONSTANT_BARRIER(bits);
870 return static_cast<Scalar>(numext::bit_cast<float>(bits));
871}
872
873template <typename Packet, bool HasIntegerBits = packet_bit_pattern_traits<Packet>::HasIntegerBits,
874 bool IsScalar = is_scalar<Packet>::value>
875struct psignmask_impl;
876
877template <typename Packet, bool IsScalar>
878struct psignmask_impl<Packet, true, IsScalar> {
879 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet run() {
880 using Scalar = typename packet_bit_pattern_traits<Packet>::Scalar;
881 using Bits = typename packet_bit_pattern_traits<Packet>::Bits;
882 constexpr Bits kSignBit = static_cast<Bits>(Bits(1) << (CHAR_BIT * sizeof(Scalar) - 1));
883 return pset1frombits<Packet, Bits>(kSignBit);
884 }
885};
886
887template <typename Scalar>
888struct psignmask_impl<Scalar, false, true> {
889 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Scalar run() { return pscalar_from_float_bits<Scalar>(0x80000000u); }
890};
891
902template <typename Packet>
903EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet psignmask() {
904 return psignmask_impl<Packet>::run();
905}
906
917template <typename Packet, bool HasIntegerBits = packet_bit_pattern_traits<Packet>::HasIntegerBits,
918 bool IsScalar = is_scalar<Packet>::value>
919struct pinf_impl;
920
921template <typename Packet, bool IsScalar>
922struct pinf_impl<Packet, true, IsScalar> {
923 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet run() {
924 using Scalar = typename packet_bit_pattern_traits<Packet>::Scalar;
925 using Bits = typename packet_bit_pattern_traits<Packet>::Bits;
926 constexpr int kMantissaBits = std::numeric_limits<Scalar>::digits - 1;
927 constexpr int kExponentBits = static_cast<int>(CHAR_BIT * sizeof(Scalar)) - 1 - kMantissaBits;
928 constexpr Bits kInf = static_cast<Bits>(((Bits(1) << kExponentBits) - 1) << kMantissaBits);
929 return pset1frombits<Packet, Bits>(kInf);
930 }
931};
932
933template <typename Scalar>
934struct pinf_impl<Scalar, false, true> {
935 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Scalar run() { return pscalar_from_float_bits<Scalar>(0x7f800000u); }
936};
937
938template <typename Packet>
939EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet pinf() {
940 return pinf_impl<Packet>::run();
941}
942
944template <typename Packet, bool HasIntegerBits = packet_bit_pattern_traits<Packet>::HasIntegerBits,
945 bool IsScalar = is_scalar<Packet>::value>
946struct pnan_impl;
947
948template <typename Packet, bool IsScalar>
949struct pnan_impl<Packet, true, IsScalar> {
950 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet run() {
951 using Scalar = typename packet_bit_pattern_traits<Packet>::Scalar;
952 using Bits = typename packet_bit_pattern_traits<Packet>::Bits;
953 constexpr int kMantissaBits = std::numeric_limits<Scalar>::digits - 1;
954 constexpr int kExponentBits = static_cast<int>(CHAR_BIT * sizeof(Scalar)) - 1 - kMantissaBits;
955 constexpr Bits kInf = static_cast<Bits>(((Bits(1) << kExponentBits) - 1) << kMantissaBits);
956 constexpr Bits kNaN = static_cast<Bits>(kInf | (Bits(1) << (kMantissaBits - 1)));
957 return pset1frombits<Packet, Bits>(kNaN);
958 }
959};
960
961template <typename Scalar>
962struct pnan_impl<Scalar, false, true> {
963 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Scalar run() { return pscalar_from_float_bits<Scalar>(0x7fc00000u); }
964};
965
966template <typename Packet>
967EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet pnan() {
968 return pnan_impl<Packet>::run();
969}
970
971template <typename Scalar, std::enable_if_t<std::is_trivially_copyable<Scalar>::value, int> = 0>
972EIGEN_DEVICE_FUNC inline Scalar pload1_scalar(const Scalar* a) {
973 Scalar scalar;
974 EIGEN_USING_STD(memcpy)
975 memcpy(&scalar, a, sizeof(Scalar));
976 return scalar;
977}
978
979template <typename Scalar, std::enable_if_t<!std::is_trivially_copyable<Scalar>::value, int> = 0>
980EIGEN_DEVICE_FUNC inline Scalar pload1_scalar(const Scalar* a) {
981 return Scalar(*a);
982}
983
985template <typename Packet>
986EIGEN_DEVICE_FUNC inline Packet pload1(const typename unpacket_traits<Packet>::type* a) {
987 using Scalar = typename unpacket_traits<Packet>::type;
988 return pset1<Packet>(pload1_scalar<Scalar>(a));
989}
990
996template <typename Packet>
997EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet ploaddup(const typename unpacket_traits<Packet>::type* from) {
998 return pload1<Packet>(from);
999}
1000
1007template <typename Packet>
1008EIGEN_DEVICE_FUNC inline Packet ploadquad(const typename unpacket_traits<Packet>::type* from) {
1009 return pload1<Packet>(from);
1010}
1011
1021template <typename Packet>
1022EIGEN_DEVICE_FUNC inline void pbroadcast4(const typename unpacket_traits<Packet>::type* a, Packet& a0, Packet& a1,
1023 Packet& a2, Packet& a3) {
1024 a0 = pload1<Packet>(a + 0);
1025 a1 = pload1<Packet>(a + 1);
1026 a2 = pload1<Packet>(a + 2);
1027 a3 = pload1<Packet>(a + 3);
1028}
1029
1037template <typename Packet>
1038EIGEN_DEVICE_FUNC inline void pbroadcast2(const typename unpacket_traits<Packet>::type* a, Packet& a0, Packet& a1) {
1039 a0 = pload1<Packet>(a + 0);
1040 a1 = pload1<Packet>(a + 1);
1041}
1042
1044template <typename Packet>
1045EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet plset(const typename unpacket_traits<Packet>::type& a) {
1046 return a;
1047}
1048
1051template <typename Packet>
1052EIGEN_DEVICE_FUNC inline Packet peven_mask(const Packet& /*a*/) {
1053 using Scalar = typename unpacket_traits<Packet>::type;
1054 if (is_scalar<Packet>::value) {
1055 // The scalar "mask" is numeric: true is represented by the value one.
1056 return pset1<Packet>(Scalar(1));
1057 }
1058 const size_t n = unpacket_traits<Packet>::size;
1059 Packet b;
1060 char* bytes = reinterpret_cast<char*>(&b);
1061 for (size_t i = 0; i < n; ++i) {
1062 memset(bytes + i * sizeof(Scalar), ((i & 1) == 0 ? 0xff : 0), sizeof(Scalar));
1063 }
1064 EIGEN_FAST_MATH_CONSTANT_BARRIER(b);
1065 return b;
1066}
1067
1069template <typename Scalar, typename Packet>
1070EIGEN_DEVICE_FUNC inline void pstore(Scalar* to, const Packet& from) {
1071 (*to) = from;
1072}
1073
1077template <typename Scalar, typename Packet>
1078EIGEN_DEVICE_FUNC inline void pstore_partial(Scalar* to, const Packet& from, const Index n, const Index offset = 0) {
1079 const Index packet_size = unpacket_traits<Packet>::size;
1080 eigen_assert(n + offset <= packet_size && "number of elements plus offset will write past end of packet");
1081 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) Scalar elements[packet_size];
1082 pstore<Scalar>(elements, from);
1083 for (Index i = 0; i < numext::mini(n, packet_size - offset); i++) {
1084 to[i] = elements[i + offset];
1085 }
1086}
1087
1089template <typename Scalar, typename Packet>
1090EIGEN_DEVICE_FUNC inline void pstoreu(Scalar* to, const Packet& from) {
1091 (*to) = from;
1092}
1093
1095template <typename Scalar, typename Packet>
1096EIGEN_DEVICE_FUNC inline void pstoreu_partial(Scalar* to, const Packet& from, const Index n, const Index offset = 0) {
1097 const Index packet_size = unpacket_traits<Packet>::size;
1098 eigen_assert(n + offset <= packet_size && "number of elements plus offset will write past end of packet");
1099 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) Scalar elements[packet_size];
1100 pstore<Scalar>(elements, from);
1101 for (Index i = 0; i < numext::mini(n, packet_size - offset); i++) {
1102 to[i] = elements[i + offset];
1103 }
1104}
1105
1110template <typename Scalar, typename Packet>
1111EIGEN_DEVICE_FUNC inline std::enable_if_t<unpacket_traits<Packet>::masked_store_available, void> pstoreu(
1112 Scalar* to, const Packet& from, typename unpacket_traits<Packet>::mask_t umask);
1113
1114template <typename Scalar, typename Packet>
1115EIGEN_DEVICE_FUNC inline Packet pgather(const Scalar* from, Index /*stride*/) {
1116 return ploadu<Packet>(from);
1117}
1118
1119template <typename Scalar, typename Packet>
1120EIGEN_DEVICE_FUNC inline Packet pgather_partial(const Scalar* from, Index stride, const Index n) {
1121 const Index packet_size = unpacket_traits<Packet>::size;
1122 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) Scalar elements[packet_size] = {Scalar(0)};
1123 for (Index i = 0; i < numext::mini(n, packet_size); i++) {
1124 elements[i] = from[i * stride];
1125 }
1126 return pload<Packet>(elements);
1127}
1128
1129template <typename Scalar, typename Packet>
1130EIGEN_DEVICE_FUNC inline void pscatter(Scalar* to, const Packet& from, Index /*stride*/) {
1131 pstore(to, from);
1132}
1133
1134template <typename Scalar, typename Packet>
1135EIGEN_DEVICE_FUNC inline void pscatter_partial(Scalar* to, const Packet& from, Index stride, const Index n) {
1136 const Index packet_size = unpacket_traits<Packet>::size;
1137 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) Scalar elements[packet_size];
1138 pstore<Scalar>(elements, from);
1139 for (Index i = 0; i < numext::mini(n, packet_size); i++) {
1140 to[i * stride] = elements[i];
1141 }
1142}
1143
1145template <typename Scalar>
1146EIGEN_DEVICE_FUNC inline void prefetch(const Scalar* addr) {
1147#if defined(EIGEN_HIP_DEVICE_COMPILE)
1148 // do nothing
1149#elif defined(EIGEN_CUDA_ARCH)
1150#if defined(__LP64__) || EIGEN_OS_WIN64
1151 // 64-bit pointer operand constraint for inlined asm
1152 asm(" prefetch.L1 [ %1 ];" : "=l"(addr) : "l"(addr));
1153#else
1154 // 32-bit pointer operand constraint for inlined asm
1155 asm(" prefetch.L1 [ %1 ];" : "=r"(addr) : "r"(addr));
1156#endif
1157#elif (!EIGEN_COMP_MSVC) && (EIGEN_COMP_GNUC || EIGEN_COMP_CLANG || EIGEN_COMP_ICC)
1158 __builtin_prefetch(addr);
1159#endif
1160}
1161
1163template <typename Packet>
1164EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet preverse(const Packet& a) {
1165 return a;
1166}
1167
1169template <typename Packet>
1170EIGEN_DEVICE_FUNC inline Packet pcplxflip(const Packet& a) {
1171 return Packet(numext::imag(a), numext::real(a));
1172}
1173
1175// TODO(rmlarsen): Define and use in all complex backends.
1176template <typename Packet>
1177EIGEN_DEVICE_FUNC inline Packet pdupreal(const Packet& a) {
1178 return Packet(numext::real(a), numext::real(a));
1179}
1180
1182// TODO(rmlarsen): Define and use in all complex backends.
1183template <typename Packet>
1184EIGEN_DEVICE_FUNC inline Packet pdupimag(const Packet& a) {
1185 return Packet(numext::imag(a), numext::imag(a));
1186}
1187
1188/**************************
1189 * Special math functions
1190 ***************************/
1191
1192// Declared ahead of pisnan_impl so the complex case can use a backend's pisnan for the real packet.
1193template <typename Packet>
1194EIGEN_DEVICE_FUNC inline Packet pisnan(const Packet& a);
1195
1196// Implemented without ptrue: an all-ones float packet is a NaN bit pattern, which under
1197// fast-math flags clang turns into a poison constant that deletes any expression it flows
1198// into.
1199template <typename Packet, bool IsComplex = NumTraits<typename unpacket_traits<Packet>::type>::IsComplex,
1200 bool IsScalar = is_scalar<Packet>::value,
1201 bool IsInteger = NumTraits<typename unpacket_traits<Packet>::type>::IsInteger>
1202struct pisnan_impl {
1203 // Equivalent to !(a == a).
1204 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) { return pcmp_lt_or_nan(a, a); }
1205};
1206
1207// Integer scalars have no NaN; the answer is the all-false mask. The generic path is unusable
1208// here: pcmp_lt_or_nan has no meaningful integer semantics (and its generic form does not even
1209// compile for integer SIMD packets).
1210template <typename Packet, bool IsScalar>
1211struct pisnan_impl<Packet, false, IsScalar, true> {
1212 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) { return pzero(a); }
1213};
1214
1215template <typename Packet, bool IsInteger>
1216struct pisnan_impl<Packet, true, false, IsInteger> {
1217 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) {
1218 using RealPacket = typename unpacket_traits<Packet>::as_real;
1219 // A NaN in either the real or the imaginary lane marks the whole complex element.
1220 Packet nan_lanes = Packet(pisnan<RealPacket>(a.v));
1221 return por(nan_lanes, pcplxflip(nan_lanes));
1222 }
1223};
1224
1225// Scalar complex arguments have no wrapped real packet; combine the per-component results in the
1226// value domain, where the scalar mask convention is Scalar(1)/Scalar(0).
1227template <typename Scalar, bool IsInteger>
1228struct pisnan_impl<Scalar, true, true, IsInteger> {
1229 static EIGEN_DEVICE_FUNC inline Scalar run(const Scalar& a) {
1230 using RealScalar = typename NumTraits<Scalar>::Real;
1231 const RealScalar nan_mask =
1232 por(pisnan_impl<RealScalar>::run(numext::real(a)), pisnan_impl<RealScalar>::run(numext::imag(a)));
1233 return Scalar(nan_mask);
1234 }
1235};
1236
1238template <typename Packet>
1239EIGEN_DEVICE_FUNC inline Packet pisnan(const Packet& a) {
1240 return pisnan_impl<Packet>::run(a);
1241}
1242
1243template <typename Packet, bool IsInteger = NumTraits<typename unpacket_traits<Packet>::type>::IsInteger>
1244struct pisinf_impl {
1245 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) { return pcmp_eq(pabs(a), pinf<Packet>()); }
1246};
1247
1248// Integer scalars have no infinity; the answer is the all-false mask. The generic path is wrong
1249// for them: pinf() synthesizes its bit pattern from numeric_limits digits, which for int32 yields
1250// 2^30, so |a| == 2^30 would read as "inf".
1251template <typename Packet>
1252struct pisinf_impl<Packet, true> {
1253 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) { return pzero(a); }
1254};
1255
1257template <typename Packet>
1258EIGEN_DEVICE_FUNC inline Packet pisinf(const Packet& a) {
1259 return pisinf_impl<Packet>::run(a);
1260}
1261
1262template <typename Packet, bool IsInteger = NumTraits<typename unpacket_traits<Packet>::type>::IsInteger>
1263struct pisfinite_impl {
1264 // |a| < inf is a single comparison that is false for both NaN and infinities.
1265 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) { return pcmp_lt(pabs(a), pinf<Packet>()); }
1266};
1267
1268// Integer scalars are always finite; the answer is the all-true mask (safe for integer packets,
1269// where all-ones is not a NaN bit pattern).
1270template <typename Packet>
1271struct pisfinite_impl<Packet, true> {
1272 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) { return ptrue(a); }
1273};
1274
1276template <typename Packet>
1277EIGEN_DEVICE_FUNC inline Packet pisfinite(const Packet& a) {
1278 return pisfinite_impl<Packet>::run(a);
1279}
1280
1282template <typename Packet>
1283EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet psin(const Packet& a) {
1284 EIGEN_USING_STD(sin);
1285 return sin(a);
1286}
1287
1289template <typename Packet>
1290EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pcos(const Packet& a) {
1291 EIGEN_USING_STD(cos);
1292 return cos(a);
1293}
1294
1296template <typename Packet>
1297EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet ptan(const Packet& a) {
1298 EIGEN_USING_STD(tan);
1299 return tan(a);
1300}
1301
1303template <typename Packet>
1304EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pasin(const Packet& a) {
1305 EIGEN_USING_STD(asin);
1306 return asin(a);
1307}
1308
1310template <typename Packet>
1311EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pacos(const Packet& a) {
1312 EIGEN_USING_STD(acos);
1313 return acos(a);
1314}
1315
1317template <typename Packet>
1318EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet psinh(const Packet& a) {
1319 EIGEN_USING_STD(sinh);
1320 return sinh(a);
1321}
1322
1324template <typename Packet>
1325EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pcosh(const Packet& a) {
1326 EIGEN_USING_STD(cosh);
1327 return cosh(a);
1328}
1329
1331template <typename Packet>
1332EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet patan(const Packet& a) {
1333 EIGEN_USING_STD(atan);
1334 return atan(a);
1335}
1336
1338template <typename Packet>
1339EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet ptanh(const Packet& a) {
1340 EIGEN_USING_STD(tanh);
1341 return tanh(a);
1342}
1343
1345template <typename Packet>
1346EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet patanh(const Packet& a) {
1347 EIGEN_USING_STD(atanh);
1348 return atanh(a);
1349}
1350
1352template <typename Packet>
1353EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pasinh(const Packet& a) {
1354 EIGEN_USING_STD(asinh);
1355 return asinh(a);
1356}
1357
1359template <typename Packet>
1360EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pacosh(const Packet& a) {
1361 EIGEN_USING_STD(acosh);
1362 return acosh(a);
1363}
1364
1366template <typename Packet>
1367EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pexp(const Packet& a) {
1368 return numext::exp(a);
1369}
1370
1372template <typename Packet>
1373EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pexp2(const Packet& a) {
1374 return numext::exp2(a);
1375}
1376
1378template <typename Packet>
1379EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pexpm1(const Packet& a) {
1380 return numext::expm1(a);
1381}
1382
1384template <typename Packet>
1385EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet plog(const Packet& a) {
1386 EIGEN_USING_STD(log);
1387 return log(a);
1388}
1389
1391template <typename Packet>
1392EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet plog1p(const Packet& a) {
1393 return numext::log1p(a);
1394}
1395
1397template <typename Packet>
1398EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet plog10(const Packet& a) {
1399 EIGEN_USING_STD(log10);
1400 return log10(a);
1401}
1402
1403template <typename Packet, bool IsComplexPacket = NumTraits<typename unpacket_traits<Packet>::type>::IsComplex &&
1404 !is_scalar<Packet>::value>
1405struct plog2_impl {
1406 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) {
1407 using Scalar = typename internal::unpacket_traits<Packet>::type;
1408 using RealScalar = typename NumTraits<Scalar>::Real;
1409 return pmul(pset1<Packet>(Scalar(RealScalar(EIGEN_LOG2E))), plog(a));
1410 }
1411};
1412
1413// Scale both parts by the real factor: the complex product with (log2(e), 0) is NaN where log(a) is infinite.
1414template <typename Packet>
1415struct plog2_impl<Packet, true> {
1416 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) {
1417 using RealPacket = typename unpacket_traits<Packet>::as_real;
1418 using RealScalar = typename unpacket_traits<RealPacket>::type;
1419 return Packet(pmul(pset1<RealPacket>(RealScalar(EIGEN_LOG2E)), plog(a).v));
1420 }
1421};
1422
1424template <typename Packet>
1425EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet plog2(const Packet& a) {
1426 return plog2_impl<Packet>::run(a);
1427}
1428
1430template <typename Packet>
1431EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet psqrt(const Packet& a) {
1432 return numext::sqrt(a);
1433}
1434
1436template <typename Packet>
1437EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pcbrt(const Packet& a) {
1438 return numext::cbrt(a);
1439}
1440
1441template <typename Packet, bool IsScalar = is_scalar<Packet>::value,
1442 bool IsInteger = NumTraits<typename unpacket_traits<Packet>::type>::IsInteger>
1443struct nearest_integer_packetop_impl {
1444 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet run_floor(const Packet& x) { return numext::floor(x); }
1445 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet run_ceil(const Packet& x) { return numext::ceil(x); }
1446 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet run_rint(const Packet& x) { return numext::rint(x); }
1447 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet run_round(const Packet& x) { return numext::round(x); }
1448 static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet run_trunc(const Packet& x) { return numext::trunc(x); }
1449};
1450
1452template <typename Packet>
1453EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet pround(const Packet& a) {
1454 return nearest_integer_packetop_impl<Packet>::run_round(a);
1455}
1456
1458template <typename Packet>
1459EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet pfloor(const Packet& a) {
1460 return nearest_integer_packetop_impl<Packet>::run_floor(a);
1461}
1462
1465template <typename Packet>
1466EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet print(const Packet& a) {
1467 return nearest_integer_packetop_impl<Packet>::run_rint(a);
1468}
1469
1471template <typename Packet>
1472EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet pceil(const Packet& a) {
1473 return nearest_integer_packetop_impl<Packet>::run_ceil(a);
1474}
1475
1477template <typename Packet>
1478EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Packet ptrunc(const Packet& a) {
1479 return nearest_integer_packetop_impl<Packet>::run_trunc(a);
1480}
1481
1482template <typename Packet, typename EnableIf = void>
1483struct psign_impl {
1484 static EIGEN_DEVICE_FUNC inline Packet run(const Packet& a) { return numext::sign(a); }
1485};
1486
1488template <typename Packet>
1489EIGEN_DEVICE_FUNC inline Packet psign(const Packet& a) {
1490 return psign_impl<Packet>::run(a);
1491}
1492
1493template <>
1494EIGEN_DEVICE_FUNC inline bool psign(const bool& a) {
1495 return a;
1496}
1497
1499template <typename Packet>
1500EIGEN_DEVICE_FUNC inline typename unpacket_traits<Packet>::type pfirst(const Packet& a) {
1501 return a;
1502}
1503
1508template <typename Packet>
1509EIGEN_DEVICE_FUNC inline std::conditional_t<(unpacket_traits<Packet>::size % 8) == 0,
1510 typename unpacket_traits<Packet>::half, Packet>
1511predux_half(const Packet& a) {
1512 return a;
1513}
1514
1515// Slow generic implementation of Packet reduction.
1516template <typename Packet, typename Op>
1517EIGEN_DEVICE_FUNC inline typename unpacket_traits<Packet>::type predux_helper(const Packet& a, Op op) {
1518 using Scalar = typename unpacket_traits<Packet>::type;
1519 const size_t n = unpacket_traits<Packet>::size;
1520 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) Scalar elements[n];
1521 pstoreu<Scalar>(elements, a);
1522 for (size_t k = n / 2; k > 0; k /= 2) {
1523 for (size_t i = 0; i < k; ++i) {
1524 elements[i] = op(elements[i], elements[i + k]);
1525 }
1526 }
1527 return elements[0];
1528}
1529
1530template <typename Packet, std::enable_if_t<unpacket_traits<Packet>::size == 1, int> = 0>
1531EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE typename unpacket_traits<Packet>::type predux_one_element(const Packet& a) {
1532 return pfirst(a);
1533}
1534
1536template <typename Packet>
1537EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE typename unpacket_traits<Packet>::type predux(const Packet& a) {
1538 return predux_one_element(a);
1539}
1540
1542template <typename Packet>
1543EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE typename unpacket_traits<Packet>::type predux_mul(const Packet& a) {
1544 using Scalar = typename unpacket_traits<Packet>::type;
1545 return predux_helper(a, EIGEN_BINARY_OP_NAN_PROPAGATION(Scalar, (pmul<Scalar>)));
1546}
1547
1549template <typename Packet>
1550EIGEN_DEVICE_FUNC inline typename unpacket_traits<Packet>::type predux_min(const Packet& a) {
1551 using Scalar = typename unpacket_traits<Packet>::type;
1552 return predux_helper(a, EIGEN_BINARY_OP_NAN_PROPAGATION(Scalar, (pmin<Scalar>)));
1553}
1554
1556template <typename Packet>
1557EIGEN_DEVICE_FUNC inline typename unpacket_traits<Packet>::type predux_max(const Packet& a) {
1558 using Scalar = typename unpacket_traits<Packet>::type;
1559 return predux_helper(a, EIGEN_BINARY_OP_NAN_PROPAGATION(Scalar, (pmax<Scalar>)));
1560}
1561
1562template <int NaNPropagation, typename Packet>
1563struct predux_min_max_helper_impl {
1564 using Scalar = typename unpacket_traits<Packet>::type;
1565 static constexpr bool UsePredux_ = NaNPropagation == PropagateFast || NumTraits<Scalar>::IsInteger;
1566 template <bool UsePredux = UsePredux_, std::enable_if_t<!UsePredux, bool> = true>
1567 static EIGEN_DEVICE_FUNC inline Scalar run_min(const Packet& a) {
1568 return predux_helper(a, EIGEN_BINARY_OP_NAN_PROPAGATION(Scalar, (pmin<NaNPropagation, Scalar>)));
1569 }
1570 template <bool UsePredux = UsePredux_, std::enable_if_t<!UsePredux, bool> = true>
1571 static EIGEN_DEVICE_FUNC inline Scalar run_max(const Packet& a) {
1572 return predux_helper(a, EIGEN_BINARY_OP_NAN_PROPAGATION(Scalar, (pmax<NaNPropagation, Scalar>)));
1573 }
1574 template <bool UsePredux = UsePredux_, std::enable_if_t<UsePredux, bool> = true>
1575 static EIGEN_DEVICE_FUNC inline Scalar run_min(const Packet& a) {
1576 return predux_min(a);
1577 }
1578 template <bool UsePredux = UsePredux_, std::enable_if_t<UsePredux, bool> = true>
1579 static EIGEN_DEVICE_FUNC inline Scalar run_max(const Packet& a) {
1580 return predux_max(a);
1581 }
1582};
1583
1584template <int NaNPropagation, typename Packet>
1585EIGEN_DEVICE_FUNC inline typename unpacket_traits<Packet>::type predux_min(const Packet& a) {
1586 return predux_min_max_helper_impl<NaNPropagation, Packet>::run_min(a);
1587}
1588
1589template <int NaNPropagation, typename Packet>
1590EIGEN_DEVICE_FUNC inline typename unpacket_traits<Packet>::type predux_max(const Packet& a) {
1591 return predux_min_max_helper_impl<NaNPropagation, Packet>::run_max(a);
1592}
1593
1594#undef EIGEN_BINARY_OP_NAN_PROPAGATION
1595
1596template <typename Packet, bool IsBoolean = std::is_same<typename unpacket_traits<Packet>::type, bool>::value>
1597struct predux_count_impl {
1598 EIGEN_DEVICE_FUNC static EIGEN_STRONG_INLINE Index run(const Packet& a) {
1599 using Scalar = typename unpacket_traits<Packet>::type;
1600 const Packet true_values = pandnot(pset1<Packet>(Scalar(1)), pcmp_eq(a, pzero(a)));
1601 return static_cast<Index>(numext::real(predux(true_values)));
1602 }
1603};
1604
1605template <typename Packet>
1606struct predux_count_impl<Packet, true> {
1607 EIGEN_DEVICE_FUNC static EIGEN_STRONG_INLINE Index run(const Packet& a) {
1608 using Scalar = typename unpacket_traits<Packet>::type;
1609 constexpr int PacketSize = unpacket_traits<Packet>::size;
1610 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) Scalar values[PacketSize];
1611 pstoreu<Scalar>(values, a);
1612 Index result = 0;
1613 for (int i = 0; i < PacketSize; ++i) result += values[i] ? 1 : 0;
1614 return result;
1615 }
1616};
1617
1619template <typename Packet>
1620EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index predux_count(const Packet& a) {
1621 return predux_count_impl<Packet>::run(a);
1622}
1623
1627template <typename Packet>
1628EIGEN_DEVICE_FUNC inline bool predux_any(const Packet& a) {
1629 // Dirty but generic implementation where "true" is assumed to be non 0 and all the sames.
1630 // It is expected that "true" is either:
1631 // - Scalar(1)
1632 // - bits full of ones (NaN for floats),
1633 // - or first bit equals to 1 (1 for ints, smallest denormal for floats).
1634 // This arithmetic fallback boils down to a no-op for scalars. Vector backends whose masks use floating-point bit
1635 // patterns must specialize this with an integer-bit reduction because fast-math or FTZ can discard those values.
1636 using Scalar = typename unpacket_traits<Packet>::type;
1637 return numext::not_equal_strict(predux(a), Scalar(0));
1638}
1639
1640template <typename Packet, bool IsBoolean = std::is_same<typename unpacket_traits<Packet>::type, bool>::value>
1641struct predux_all_impl {
1642 EIGEN_DEVICE_FUNC static EIGEN_STRONG_INLINE bool run(const Packet& a) { return !predux_any(pcmp_eq(a, pzero(a))); }
1643};
1644
1645template <typename Packet>
1646struct predux_all_impl<Packet, true> {
1647 EIGEN_DEVICE_FUNC static EIGEN_STRONG_INLINE bool run(const Packet& a) { return predux_mul(a); }
1648};
1649
1651template <typename Packet>
1652EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE bool predux_all(const Packet& a) {
1653 return predux_all_impl<Packet>::run(a);
1654}
1655
1656/***************************************************************************
1657 * The following functions might not have to be overwritten for vectorized types
1658 ***************************************************************************/
1659
1660template <typename Packet, typename EnableIf = void>
1661struct pmadd_impl {
1662 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet pmadd(const Packet& a, const Packet& b, const Packet& c) {
1663 return padd(pmul(a, b), c);
1664 }
1665 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet pmsub(const Packet& a, const Packet& b, const Packet& c) {
1666 return psub(pmul(a, b), c);
1667 }
1668 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet pnmadd(const Packet& a, const Packet& b, const Packet& c) {
1669 return psub(c, pmul(a, b));
1670 }
1671 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet pnmsub(const Packet& a, const Packet& b, const Packet& c) {
1672 return pnegate(padd(pmul(a, b), c));
1673 }
1674};
1675
1676template <typename Scalar>
1677struct pmadd_impl<Scalar, std::enable_if_t<is_scalar<Scalar>::value && NumTraits<Scalar>::IsSigned>> {
1678 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Scalar pmadd(const Scalar& a, const Scalar& b, const Scalar& c) {
1679 return numext::madd<Scalar>(a, b, c);
1680 }
1681 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Scalar pmsub(const Scalar& a, const Scalar& b, const Scalar& c) {
1682 return numext::madd<Scalar>(a, b, Scalar(-c));
1683 }
1684 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Scalar pnmadd(const Scalar& a, const Scalar& b, const Scalar& c) {
1685 return numext::madd<Scalar>(Scalar(-a), b, c);
1686 }
1687 static EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Scalar pnmsub(const Scalar& a, const Scalar& b, const Scalar& c) {
1688 return -Scalar(numext::madd<Scalar>(a, b, c));
1689 }
1690};
1691
1692// Multiply-add instructions.
1694template <typename Packet>
1695EIGEN_DEVICE_FUNC inline Packet pmadd(const Packet& a, const Packet& b, const Packet& c) {
1696 return pmadd_impl<Packet>::pmadd(a, b, c);
1697}
1698
1700template <typename Packet>
1701EIGEN_DEVICE_FUNC inline Packet pmsub(const Packet& a, const Packet& b, const Packet& c) {
1702 return pmadd_impl<Packet>::pmsub(a, b, c);
1703}
1704
1706template <typename Packet>
1707EIGEN_DEVICE_FUNC inline Packet pnmadd(const Packet& a, const Packet& b, const Packet& c) {
1708 return pmadd_impl<Packet>::pnmadd(a, b, c);
1709}
1710
1712template <typename Packet>
1713EIGEN_DEVICE_FUNC inline Packet pnmsub(const Packet& a, const Packet& b, const Packet& c) {
1714 return pmadd_impl<Packet>::pnmsub(a, b, c);
1715}
1716
1719// NOTE: this function must really be templated on the packet type (think about different packet types for the same
1720// scalar type)
1721template <typename Packet>
1722inline void pstore1(typename unpacket_traits<Packet>::type* to, const typename unpacket_traits<Packet>::type& a) {
1723 pstore(to, pset1<Packet>(a));
1724}
1725
1728template <typename Packet, int Alignment>
1729EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet ploadt(const typename unpacket_traits<Packet>::type* from) {
1730 EIGEN_IF_CONSTEXPR (Alignment >= unpacket_traits<Packet>::alignment) {
1731 return pload<Packet>(from);
1732 } else {
1733 return ploadu<Packet>(from);
1734 }
1735}
1736
1739template <typename Packet, int Alignment>
1740EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet ploadt_partial(const typename unpacket_traits<Packet>::type* from,
1741 const Index n, const Index offset = 0) {
1742 EIGEN_IF_CONSTEXPR (Alignment >= unpacket_traits<Packet>::alignment) {
1743 return pload_partial<Packet>(from, n, offset);
1744 } else {
1745 return ploadu_partial<Packet>(from, n, offset);
1746 }
1747}
1748
1751template <typename Scalar, typename Packet, int Alignment>
1752EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE void pstoret(Scalar* to, const Packet& from) {
1753 EIGEN_IF_CONSTEXPR (Alignment >= unpacket_traits<Packet>::alignment) {
1754 pstore(to, from);
1755 } else {
1756 pstoreu(to, from);
1757 }
1758}
1759
1762template <typename Scalar, typename Packet, int Alignment>
1763EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE void pstoret_partial(Scalar* to, const Packet& from, const Index n,
1764 const Index offset = 0) {
1765 EIGEN_IF_CONSTEXPR (Alignment >= unpacket_traits<Packet>::alignment) {
1766 pstore_partial(to, from, n, offset);
1767 } else {
1768 pstoreu_partial(to, from, n, offset);
1769 }
1770}
1771
1777template <typename Packet, int LoadMode>
1778EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet ploadt_ro(const typename unpacket_traits<Packet>::type* from) {
1779 return ploadt<Packet, LoadMode>(from);
1780}
1781
1782/***************************************************************************
1783 * Fast complex products (GCC generates a function call which is very slow)
1784 ***************************************************************************/
1785
1786// Eigen+CUDA does not support complexes.
1787#if !defined(EIGEN_GPUCC)
1788
1789template <>
1790inline std::complex<float> pmul(const std::complex<float>& a, const std::complex<float>& b) {
1791 return std::complex<float>(a.real() * b.real() - a.imag() * b.imag(), a.imag() * b.real() + a.real() * b.imag());
1792}
1793
1794template <>
1795inline std::complex<double> pmul(const std::complex<double>& a, const std::complex<double>& b) {
1796 return std::complex<double>(a.real() * b.real() - a.imag() * b.imag(), a.imag() * b.real() + a.real() * b.imag());
1797}
1798
1799#endif
1800
1801/***************************************************************************
1802 * PacketBlock, that is a collection of N packets where the number of words
1803 * in the packet is a multiple of N.
1804 ***************************************************************************/
1805template <typename Packet, int N = unpacket_traits<Packet>::size>
1806struct PacketBlock {
1807 Packet packet[N];
1808};
1809
1810template <typename Packet, int size = 1>
1811EIGEN_DEVICE_FUNC inline void ptranspose(PacketBlock<Packet, size>& /*kernel*/) {
1812 // Nothing to do in the scalar case, i.e. a 1x1 matrix.
1813}
1814
1816template <typename Packet>
1817EIGEN_DEVICE_FUNC inline Packet preciprocal(const Packet& a) {
1818 using Scalar = typename unpacket_traits<Packet>::type;
1819 return pdiv(pset1<Packet>(Scalar(1)), a);
1820}
1821
1823template <typename Packet>
1824EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet prsqrt(const Packet& a) {
1825 return preciprocal<Packet>(psqrt(a));
1826}
1827
1828template <typename Packet, bool IsScalar = is_scalar<Packet>::value,
1829 bool IsInteger = NumTraits<typename unpacket_traits<Packet>::type>::IsInteger,
1830 bool IsUnsigned = IsInteger && !NumTraits<typename unpacket_traits<Packet>::type>::IsSigned>
1831struct psignbit_impl;
1832template <typename Packet, bool IsInteger, bool IsUnsigned>
1833struct psignbit_impl<Packet, true, IsInteger, IsUnsigned> {
1834 EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE static constexpr Packet run(const Packet& a) { return numext::signbit(a); }
1835};
1836template <typename Packet>
1837struct psignbit_impl<Packet, false, false, false> {
1838 // generic implementation if not specialized in PacketMath.h
1839 // slower than arithmetic shift
1840 using Scalar = typename unpacket_traits<Packet>::type;
1841 EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE static Packet run(const Packet& a) {
1842 const Packet cst_pos_one = pset1<Packet>(Scalar(1));
1843 const Packet cst_neg_one = pset1<Packet>(Scalar(-1));
1844 return pcmp_eq(por(pand(a, cst_neg_one), cst_pos_one), cst_neg_one);
1845 }
1846};
1847template <typename Packet>
1848struct psignbit_impl<Packet, false, true, false> {
1849 // generic implementation for signed integer packets
1850 EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE static constexpr Packet run(const Packet& a) { return pcmp_lt(a, pzero(a)); }
1851};
1852template <typename Packet>
1853struct psignbit_impl<Packet, false, true, true> {
1854 EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE static constexpr Packet run(const Packet& a) { return pzero(a); }
1855};
1857template <typename Packet>
1858EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE constexpr Packet psignbit(const Packet& a) {
1859 return psignbit_impl<Packet>::run(a);
1860}
1861
1863template <typename Packet, std::enable_if_t<is_scalar<Packet>::value, int> = 0>
1864EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet patan2(const Packet& y, const Packet& x) {
1865 return numext::atan2(y, x);
1866}
1867
1869template <typename Packet, std::enable_if_t<!is_scalar<Packet>::value, int> = 0>
1870EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet patan2(const Packet& y, const Packet& x) {
1871 using Scalar = typename internal::unpacket_traits<Packet>::type;
1872
1873 // See https://en.cppreference.com/w/cpp/numeric/math/atan2
1874 // for how corner cases are supposed to be handled according to the
1875 // IEEE floating-point standard (IEC 60559).
1876 const Packet kSignMask = psignmask<Packet>();
1877 const Packet kZero = pzero(x);
1878 const Packet kOne = pset1<Packet>(Scalar(1));
1879 const Packet kPi = pset1<Packet>(Scalar(EIGEN_PI));
1880
1881 const Packet x_has_signbit = psignbit(x);
1882 const Packet y_signmask = pand(y, kSignMask);
1883 const Packet x_signmask = pand(x, kSignMask);
1884 const Packet result_signmask = pxor(y_signmask, x_signmask);
1885 const Packet shift = por(pand(x_has_signbit, kPi), y_signmask);
1886
1887 const Packet x_and_y_are_same = pcmp_eq(pabs(x), pabs(y));
1888 const Packet x_and_y_are_zero = pcmp_eq(por(x, y), kZero);
1889
1890 Packet arg = pdiv(y, x);
1891 arg = pselect(x_and_y_are_same, por(kOne, result_signmask), arg);
1892 arg = pselect(x_and_y_are_zero, result_signmask, arg);
1893
1894 Packet result = patan(arg);
1895 result = padd(result, shift);
1896 return result;
1897}
1898
1900template <typename Packet, std::enable_if_t<is_scalar<Packet>::value, int> = 0>
1901EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet pcarg(const Packet& a) {
1902 return Packet(numext::arg(a));
1903}
1904
1906template <typename Packet, std::enable_if_t<!is_scalar<Packet>::value, int> = 0>
1907EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE Packet pcarg(const Packet& a) {
1908 EIGEN_STATIC_ASSERT(NumTraits<typename unpacket_traits<Packet>::type>::IsComplex,
1909 THIS METHOD IS FOR COMPLEX TYPES ONLY)
1910 using RealPacket = typename unpacket_traits<Packet>::as_real;
1911 // a // r i r i ...
1912 RealPacket aflip = pcplxflip(a).v; // i r i r ...
1913 RealPacket result = patan2(aflip, a.v); // atan2 crap atan2 crap ...
1914 return (Packet)pand(result, peven_mask(result)); // atan2 0 atan2 0 ...
1915}
1916
1919template <typename Packet>
1920EIGEN_DEVICE_FUNC inline Packet ploaduSegment(const typename unpacket_traits<Packet>::type* from, Index begin,
1921 Index count) {
1922 using Scalar = typename unpacket_traits<Packet>::type;
1923 constexpr Index PacketSize = unpacket_traits<Packet>::size;
1924 eigen_assert((begin >= 0 && count >= 0 && begin + count <= PacketSize) && "invalid range");
1925 Scalar aux[PacketSize] = {};
1926 for (Index k = begin; k < begin + count; k++) {
1927 aux[k] = from[k];
1928 }
1929 return ploadu<Packet>(aux);
1930}
1931
1934template <typename Packet>
1935EIGEN_DEVICE_FUNC inline Packet ploadSegment(const typename unpacket_traits<Packet>::type* from, Index begin,
1936 Index count) {
1937 return ploaduSegment<Packet>(from, begin, count);
1938}
1939
1943template <typename Scalar, typename Packet>
1944EIGEN_DEVICE_FUNC inline void pstoreuSegment(Scalar* to, const Packet& from, Index begin, Index count) {
1945 constexpr Index PacketSize = unpacket_traits<Packet>::size;
1946 eigen_assert((begin >= 0 && count >= 0 && begin + count <= PacketSize) && "invalid range");
1947 Scalar aux[PacketSize];
1948 pstoreu<Scalar, Packet>(aux, from);
1949 for (Index k = begin; k < begin + count; k++) {
1950 to[k] = aux[k];
1951 }
1952}
1953
1957template <typename Scalar, typename Packet>
1958EIGEN_DEVICE_FUNC inline void pstoreSegment(Scalar* to, const Packet& from, Index begin, Index count) {
1959 return pstoreuSegment(to, from, begin, count);
1960}
1961
1964template <typename Packet, int Alignment>
1965EIGEN_DEVICE_FUNC inline Packet ploadtSegment(const typename unpacket_traits<Packet>::type* from, Index begin,
1966 Index count) {
1967 constexpr int RequiredAlignment = unpacket_traits<Packet>::alignment;
1968 EIGEN_IF_CONSTEXPR (Alignment >= RequiredAlignment) {
1969 return ploadSegment<Packet>(from, begin, count);
1970 } else {
1971 return ploaduSegment<Packet>(from, begin, count);
1972 }
1973}
1974
1977template <typename Scalar, typename Packet, int Alignment>
1978EIGEN_DEVICE_FUNC inline void pstoretSegment(Scalar* to, const Packet& from, Index begin, Index count) {
1979 constexpr int RequiredAlignment = unpacket_traits<Packet>::alignment;
1980 EIGEN_IF_CONSTEXPR (Alignment >= RequiredAlignment) {
1981 pstoreSegment<Scalar, Packet>(to, from, begin, count);
1982 } else {
1983 pstoreuSegment<Scalar, Packet>(to, from, begin, count);
1984 }
1985}
1986
1987#ifndef EIGEN_NO_IO
1988
1989template <typename Packet>
1990class StreamablePacket {
1991 public:
1992 using Scalar = typename unpacket_traits<Packet>::type;
1993 StreamablePacket(const Packet& packet) { pstoreu(v_, packet); }
1994
1995 friend std::ostream& operator<<(std::ostream& os, const StreamablePacket& packet) {
1996 os << "{" << packet.v_[0];
1997 for (int i = 1; i < unpacket_traits<Packet>::size; ++i) {
1998 os << "," << packet.v_[i];
1999 }
2000 os << "}";
2001 return os;
2002 }
2003
2004 private:
2005 Scalar v_[unpacket_traits<Packet>::size];
2006};
2007
2011template <typename Packet>
2012StreamablePacket<Packet> postream(const Packet& packet) {
2013 return StreamablePacket<Packet>(packet);
2014}
2015
2016#endif // EIGEN_NO_IO
2017
2018} // end namespace internal
2019
2020} // end namespace Eigen
2021
2022#endif // EIGEN_GENERIC_PACKET_MATH_H
@ PropagateNaN
Definition Constants.h:343
@ PropagateNumbers
Definition Constants.h:345
@ PropagateFast
Definition Constants.h:341