Eigen  5.0.1
 
Loading...
Searching...
No Matches
GenericPacketMathTrig.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2007 Julien Pommier
5// Copyright (C) 2009-2019 Gael Guennebaud <gael.guennebaud@inria.fr>
6// Copyright (C) 2018-2025 Rasmus Munk Larsen <rmlarsen@gmail.com>
7//
8// This Source Code Form is subject to the terms of the Mozilla
9// Public License v. 2.0. If a copy of the MPL was not distributed
10// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
11// SPDX-License-Identifier: MPL-2.0
12
13#ifndef EIGEN_ARCH_GENERIC_PACKET_MATH_TRIG_H
14#define EIGEN_ARCH_GENERIC_PACKET_MATH_TRIG_H
15
16// IWYU pragma: private
17#include "../../InternalHeaderCheck.h"
18
19namespace Eigen {
20namespace internal {
21
22//----------------------------------------------------------------------
23// Trigonometric Functions
24//----------------------------------------------------------------------
25
26// Enum for selecting which function to compute. SinCos is intended to compute
27// pairs of Sin and Cos of the even entries in the packet, e.g.
28// SinCos([a, *, b, *]) = [sin(a), cos(a), sin(b), cos(b)].
29enum class TrigFunction : uint8_t { Sin, Cos, Tan, SinCos };
30
31// The following code is inspired by the following stack-overflow answer:
32// https://stackoverflow.com/questions/30463616/payne-hanek-algorithm-implementation-in-c/30465751#30465751
33// It has been largely optimized:
34// - By-pass calls to frexp.
35// - Aligned loads of required 96 bits of 2/pi. This is accomplished by
36// (1) balancing the mantissa and exponent to the required bits of 2/pi are
37// aligned on 8-bits, and (2) replicating the storage of the bits of 2/pi.
38// - Avoid a branch in rounding and extraction of the remaining fractional part.
39// Overall, I measured a speed up higher than x2 on x86-64.
40inline float trig_reduce_huge(float xf, Eigen::numext::int32_t* quadrant) {
41 using Eigen::numext::int32_t;
42 using Eigen::numext::int64_t;
43 using Eigen::numext::uint32_t;
44 using Eigen::numext::uint64_t;
45
46 const double pio2_62 = 3.4061215800865545e-19; // pi/2 * 2^-62
47 const uint64_t zero_dot_five = uint64_t(1) << 61; // 0.5 in 2.62-bit fixed-point format
48
49 // 192 bits of 2/pi for Payne-Hanek reduction
50 // Bits are introduced by packet of 8 to enable aligned reads.
51 static const uint32_t two_over_pi[] = {
52 0x00000028, 0x000028be, 0x0028be60, 0x28be60db, 0xbe60db93, 0x60db9391, 0xdb939105, 0x9391054a, 0x91054a7f,
53 0x054a7f09, 0x4a7f09d5, 0x7f09d5f4, 0x09d5f47d, 0xd5f47d4d, 0xf47d4d37, 0x7d4d3770, 0x4d377036, 0x377036d8,
54 0x7036d8a5, 0x36d8a566, 0xd8a5664f, 0xa5664f10, 0x664f10e4, 0x4f10e410, 0x10e41000, 0xe4100000};
55
56 uint32_t xi = numext::bit_cast<uint32_t>(xf);
57 // Below, -118 = -126 + 8.
58 // -126 is to get the exponent,
59 // +8 is to enable alignment of 2/pi's bits on 8 bits.
60 // This is possible because the fractional part of x has only 24 meaningful bits.
61 uint32_t e = (xi >> 23) - 118;
62 // Extract the mantissa and shift it to align it wrt the exponent
63 xi = ((xi & 0x007fffffu) | 0x00800000u) << (e & 0x7);
64
65 uint32_t i = e >> 3;
66 uint32_t twoopi_1 = two_over_pi[i - 1];
67 uint32_t twoopi_2 = two_over_pi[i + 3];
68 uint32_t twoopi_3 = two_over_pi[i + 7];
69
70 // Compute x * 2/pi in 2.62-bit fixed-point format.
71 uint64_t p;
72 p = uint64_t(xi) * twoopi_3;
73 p = uint64_t(xi) * twoopi_2 + (p >> 32);
74 p = (uint64_t(xi * twoopi_1) << 32) + p;
75
76 // Round to nearest: add 0.5 and extract integral part.
77 uint64_t q = (p + zero_dot_five) >> 62;
78 *quadrant = int(q);
79 // Now it remains to compute "r = x - q*pi/2" with high accuracy,
80 // since we have p=x/(pi/2) with high accuracy, we can more efficiently compute r as:
81 // r = (p-q)*pi/2,
82 // where the product can be carried out with sufficient accuracy using double precision.
83 p -= q << 62;
84 return float(double(int64_t(p)) * pio2_62);
85}
86
87template <TrigFunction Func, typename Packet>
88EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet psincos_float(const Packet& _x) {
89 using PacketI = typename unpacket_traits<Packet>::integer_packet;
90
91 const Packet cst_2oPI = pset1<Packet>(0.636619746685028076171875f); // 2/PI
92 const Packet cst_rounding_magic = pset1<Packet>(12582912); // 2^23 for rounding
93 const PacketI csti_1 = pset1<PacketI>(1);
94 const Packet cst_sign_mask = psignmask<Packet>();
95
96 Packet x = pabs(_x);
97
98 // Scale x by 2/Pi to find x's octant.
99 Packet y = pmul(x, cst_2oPI);
100
101 // Rounding trick to find nearest integer:
102 Packet y_round = padd(y, cst_rounding_magic);
103 EIGEN_OPTIMIZATION_BARRIER(y_round)
104 PacketI y_int = preinterpret<PacketI>(y_round); // last 23 digits represent integer (if abs(x)<2^24)
105 y = psub(y_round, cst_rounding_magic); // nearest integer to x * (2/pi)
106
107// Subtract y * Pi/2 to reduce x to the interval -Pi/4 <= x <= +Pi/4
108// using "Extended precision modular arithmetic"
109#if defined(EIGEN_VECTORIZE_FMA)
110 // This version requires true FMA for high accuracy.
111 // It provides a max error of 1ULP up to (with absolute_error < 5.9605e-08):
112 constexpr float huge_th = (Func == TrigFunction::Sin) ? 117435.992f : 71476.0625f;
113 x = pmadd(y, pset1<Packet>(-1.57079601287841796875f), x);
114 x = pmadd(y, pset1<Packet>(-3.1391647326017846353352069854736328125e-07f), x);
115 x = pmadd(y, pset1<Packet>(-5.390302529957764765544681040410068817436695098876953125e-15f), x);
116#else
117 // Without true FMA, the previous set of coefficients maintain 1ULP accuracy
118 // up to x<15.7 (for sin), but accuracy is immediately lost for x>15.7.
119 // We thus use one more iteration to maintain 2ULPs up to reasonably large inputs.
120
121 // The following set of coefficients maintain 1ULP up to 9.43 and 14.16 for sin and cos respectively.
122 // and 2 ULP up to:
123 constexpr float huge_th = (Func == TrigFunction::Sin) ? 25966.f : 18838.f;
124 x = pmadd(y, pset1<Packet>(-1.5703125), x); // = 0xbfc90000
125 EIGEN_OPTIMIZATION_BARRIER(x)
126 x = pmadd(y, pset1<Packet>(-0.000483989715576171875), x); // = 0xb9fdc000
127 EIGEN_OPTIMIZATION_BARRIER(x)
128 x = pmadd(y, pset1<Packet>(1.62865035235881805419921875e-07), x); // = 0x342ee000
129 EIGEN_OPTIMIZATION_BARRIER(x)
130 x = pmadd(y, pset1<Packet>(5.5644315544167710640977020375430583953857421875e-11), x); // = 0x2e74b9ee
131
132// For the record, the following set of coefficients maintain 2ULP up
133// to a slightly larger range:
134// const float huge_th = ComputeSine ? 51981.f : 39086.125f;
135// but it slightly fails to maintain 1ULP for two values of sin below pi.
136// x = pmadd(y, pset1<Packet>(-3.140625/2.), x);
137// x = pmadd(y, pset1<Packet>(-0.00048351287841796875), x);
138// x = pmadd(y, pset1<Packet>(-3.13855707645416259765625e-07), x);
139// x = pmadd(y, pset1<Packet>(-6.0771006282767103812147979624569416046142578125e-11), x);
140
141// For the record, with only 3 iterations it is possible to maintain
142// 1 ULP up to 3PI (maybe more) and 2ULP up to 255.
143// The coefficients are: 0xbfc90f80, 0xb7354480, 0x2e74b9ee
144#endif
145
146 if (predux_any(pcmp_le(pset1<Packet>(huge_th), pabs(_x)))) {
147 const int PacketSize = unpacket_traits<Packet>::size;
148 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) float vals[PacketSize];
149 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) float x_cpy[PacketSize];
150 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) Eigen::numext::int32_t y_int2[PacketSize];
151 pstoreu(vals, pabs(_x));
152 pstoreu(x_cpy, x);
153 pstoreu(y_int2, y_int);
154 for (int k = 0; k < PacketSize; ++k) {
155 float val = vals[k];
156 if (val >= huge_th && (numext::isfinite)(val)) x_cpy[k] = trig_reduce_huge(val, &y_int2[k]);
157 }
158 x = ploadu<Packet>(x_cpy);
159 y_int = ploadu<PacketI>(y_int2);
160 }
161
162 // Get the polynomial selection mask from the second bit of y_int
163 // We'll calculate both (sin and cos) polynomials and then select from the two.
164 Packet poly_mask = preinterpret<Packet>(pcmp_eq(pand(y_int, csti_1), pzero(y_int)));
165
166 Packet x2 = pmul(x, x);
167
168 // Evaluate the cos(x) polynomial. (-Pi/4 <= x <= Pi/4)
169 Packet y1 = pset1<Packet>(2.4372266125283204019069671630859375e-05f);
170 y1 = pmadd(y1, x2, pset1<Packet>(-0.00138865201734006404876708984375f));
171 y1 = pmadd(y1, x2, pset1<Packet>(0.041666619479656219482421875f));
172 y1 = pmadd(y1, x2, pset1<Packet>(-0.5f));
173 y1 = pmadd(y1, x2, pset1<Packet>(1.f));
174
175 // Evaluate the sin(x) polynomial. (-Pi/4 <= x <= Pi/4)
176 // octave/matlab code to compute those coefficients:
177 // x = (0:0.0001:pi/4)';
178 // A = [x.^3 x.^5 x.^7];
179 // w = ((1.-(x/(pi/4)).^2).^5)*2000+1; # weights trading relative accuracy
180 // c = (A'*diag(w)*A)\‍(A'*diag(w)*(sin(x)-x)); # weighted LS, linear coeff forced to 1
181 // printf('%.64f\n %.64f\n%.64f\n', c(3), c(2), c(1))
182 //
183 Packet y2 = pset1<Packet>(-0.0001959234114083702898469196984621021329076029360294342041015625f);
184 y2 = pmadd(y2, x2, pset1<Packet>(0.0083326873655616851693794799871284340042620897293090820312500000f));
185 y2 = pmadd(y2, x2, pset1<Packet>(-0.1666666203982298255503735617821803316473960876464843750000000000f));
186 y2 = pmul(y2, x2);
187 y2 = pmadd(y2, x, x);
188
189 // Select the correct result from the two polynomials.
190 // Compute the sign to apply to the polynomial.
191 // sin: sign = second_bit(y_int) xor signbit(_x)
192 // cos: sign = second_bit(y_int+1)
193 Packet sign_bit = (Func == TrigFunction::Sin) ? pxor(_x, preinterpret<Packet>(plogical_shift_left<30>(y_int)))
194 : preinterpret<Packet>(plogical_shift_left<30>(padd(y_int, csti_1)));
195 sign_bit = pand(sign_bit, cst_sign_mask); // clear all but left most bit
196
197 if ((Func == TrigFunction::SinCos) || (Func == TrigFunction::Tan)) {
198 Packet peven = peven_mask(x);
199 Packet ysin = pselect(poly_mask, y2, y1);
200 Packet ycos = pselect(poly_mask, y1, y2);
201 Packet sign_bit_sin = pxor(_x, preinterpret<Packet>(plogical_shift_left<30>(y_int)));
202 Packet sign_bit_cos = preinterpret<Packet>(plogical_shift_left<30>(padd(y_int, csti_1)));
203 sign_bit_sin = pand(sign_bit_sin, cst_sign_mask); // clear all but left most bit
204 sign_bit_cos = pand(sign_bit_cos, cst_sign_mask); // clear all but left most bit
205 y = (Func == TrigFunction::SinCos) ? pselect(peven, pxor(ysin, sign_bit_sin), pxor(ycos, sign_bit_cos))
206 : pdiv(pxor(ysin, sign_bit_sin), pxor(ycos, sign_bit_cos));
207 } else {
208 y = (Func == TrigFunction::Sin) ? pselect(poly_mask, y2, y1) : pselect(poly_mask, y1, y2);
209 y = pxor(y, sign_bit);
210 }
211 return y;
212}
213
214template <typename Packet>
215EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet psin_float(const Packet& x) {
216 return psincos_float<TrigFunction::Sin>(x);
217}
218
219template <typename Packet>
220EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pcos_float(const Packet& x) {
221 return psincos_float<TrigFunction::Cos>(x);
222}
223
224template <typename Packet>
225EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet ptan_float(const Packet& x) {
226 return psincos_float<TrigFunction::Tan>(x);
227}
228
229// Pi/2 split into 3 double-precision parts (triple-double).
230// c1 + c2 + c3 = pi/2 to ~159 bits. Computed by Sollya.
231// c1 = RD(pi/2), c2 = RD(pi/2 - c1), c3 = RD(pi/2 - c1 - c2).
232template <typename Packet>
233Packet cst_pio2_1() {
234 return pset1<Packet>(-1.5707963267948965579989817342720925807952880859375); // -0x1.921fb54442d18p0
235}
236template <typename Packet>
237Packet cst_pio2_2() {
238 return pset1<Packet>(-6.12323399573676603586882014729198302312846062338790e-17); // -0x1.1a62633145c07p-54
239}
240template <typename Packet>
241Packet cst_pio2_3() {
242 return pset1<Packet>(1.4973849048591698329435081771059920083527504761695190e-33); // 0x1.f1976b7ed8fbcp-110
243}
244
245// Trigonometric argument reduction for double.
246// Reduces x to t such that x + q * pi/2 = t, where |t| <= pi/4.
247// Uses a triple-double split of pi/2 (cst_pio2_{1,2,3}).
248template <typename Packet>
249Packet trig_reduce_small_double(const Packet& x, const Packet& q) {
250#ifdef EIGEN_HAS_SINGLE_INSTRUCTION_MADD
251 // With FMA, pmadd(a, b, c) = fl(a*b + c) in a single rounding,
252 // so Cody-Waite reduction is accurate even under catastrophic cancellation.
253 Packet t;
254 t = pmadd(cst_pio2_1<Packet>(), q, x);
255 t = pmadd(cst_pio2_2<Packet>(), q, t);
256 t = pmadd(cst_pio2_3<Packet>(), q, t);
257 return t;
258#else
259 // Without FMA, pmadd is mul + add (two roundings). For large q,
260 // pmul(pio2_1, q) rounds before the cancellation with x, losing
261 // catastrophic amounts of precision (observed: ~10 digits lost).
262 // Use error-free transformations to preserve accuracy.
263
264 // Compute q * pio2_1 exactly as a double-word using Dekker's algorithm.
265 Packet qp_hi, qp_lo;
266 twoprod(cst_pio2_1<Packet>(), q, qp_hi, qp_lo);
267
268 // Error-free addition of x and qp_hi using Knuth's 2sum.
269 // Returns t_hi + t_lo = x + qp_hi exactly, with t_hi = fl(x + qp_hi).
270 Packet t_hi = padd(x, qp_hi);
271 Packet v = psub(t_hi, x);
272 Packet t_lo = padd(psub(x, psub(t_hi, v)), psub(qp_hi, v));
273
274 // Accumulate the low part of the product and the remaining pi/2 terms.
275 t_lo = padd(t_lo, qp_lo);
276 t_lo = pmadd(cst_pio2_2<Packet>(), q, t_lo);
277 t_lo = pmadd(cst_pio2_3<Packet>(), q, t_lo);
278
279 return padd(t_hi, t_lo);
280#endif
281}
282
283template <TrigFunction Func, typename Packet>
284EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet psincos_double(const Packet& x) {
285 using PacketI = typename unpacket_traits<Packet>::integer_packet;
286 using ScalarI = typename unpacket_traits<PacketI>::type;
287
288 const Packet cst_sign_mask = psignmask<Packet>();
289
290 // If the argument is smaller than this value, use a simpler argument reduction
291 const double small_th = 15;
292 // If the argument is bigger than this value, use the non-vectorized std version
293 const double huge_th = 1e14;
294
295 // 2/PI as a double-word: hi + lo = 2/pi to ~107 bits. Computed by Sollya.
296 const Packet cst_2oPI_hi =
297 pset1<Packet>(0.63661977236758138243288840385503135621547698974609375); // 0x1.45f306dc9c883p-1
298 const Packet cst_2oPI_lo =
299 pset1<Packet>(-3.9357353350364971763790381828183628368294820823718866e-17); // -0x1.6b01ec5417056p-55
300 // Integer Packet constants
301 const PacketI cst_one = pset1<PacketI>(ScalarI(1));
302
303 Packet x_abs = pabs(x);
304
305 // Scale x by 2/Pi
306 PacketI q_int;
307 Packet s;
308
309 if (EIGEN_PREDICT_FALSE(predux_any(pcmp_le(pset1<Packet>(small_th), x_abs)))) {
310 // Medium path: use double-word product x * (2/pi) for precise quadrant computation.
311 Packet prod_hi, prod_lo;
312 twoprod(x_abs, cst_2oPI_hi, prod_hi, prod_lo);
313 // Correction for 2/pi truncation: add x * lo(2/pi)
314 prod_lo = pmadd(x_abs, cst_2oPI_lo, prod_lo);
315
316 // Round the double-word (prod_hi, prod_lo) to the nearest integer.
317 Packet q = pround(prod_hi);
318 // Compute exact fractional part to check if rounding was correct.
319 Packet frac = padd(psub(prod_hi, q), prod_lo);
320 // Correct if fractional part crossed +-0.5 boundary.
321 q = padd(q, pand(pcmp_lt(pset1<Packet>(0.5), frac), pset1<Packet>(1.0)));
322 q = padd(q, pand(pcmp_lt(frac, pset1<Packet>(-0.5)), pset1<Packet>(-1.0)));
323
324 q_int = pcast<Packet, PacketI>(q);
325 s = trig_reduce_small_double(x_abs, q);
326 } else {
327 // Small path: simple reduction with triple-double pi/2 split.
328 Packet qval_noround = pmul(x_abs, cst_2oPI_hi);
329 q_int = pcast<Packet, PacketI>(padd(qval_noround, pset1<Packet>(0.5)));
330 Packet q = pcast<PacketI, Packet>(q_int);
331 s = trig_reduce_small_double(x_abs, q);
332 }
333
334 Packet ss = pmul(s, s);
335
336 // Minimax polynomial approximation of cos(x) on [-pi/4, pi/4].
337 // cos(x) = 1 + u * P(u), where u = x^2 and P is degree 6 (7 FMAs total).
338 // Coefficients computed by Sollya fpminimax. Max polynomial error ~1.3e-19.
339 Packet scos = pset1<Packet>(-1.1368926065317776472832699312119132152576472805094454088248312473297119140625e-11);
340 scos = pmadd(scos, ss, pset1<Packet>(2.0875905481768720039634091158002593413556269297259859740734100341796875e-09));
341 scos = pmadd(scos, ss, pset1<Packet>(-2.7557315712466412785356544880299711763882442028261721134185791015625e-07));
342 scos = pmadd(scos, ss, pset1<Packet>(2.480158729424286522739599714082459058772656135261058807373046875e-05));
343 scos = pmadd(scos, ss, pset1<Packet>(-1.388888888888178789471350427220386336557567119598388671875e-03));
344 scos = pmadd(scos, ss, pset1<Packet>(4.166666666666664353702032030923874117434024810791015625e-02));
345 scos = pmadd(scos, ss, pset1<Packet>(-0.5));
346 scos = pmadd(scos, ss, pset1<Packet>(1.0));
347
348 // Minimax polynomial approximation of sin(x) on [-pi/4, pi/4].
349 // sin(x) = x * (1 + u * R(u)), where u = x^2 and R is degree 5.
350 // Computed as: x + x * u * R(u) (6 FMAs + 1 mul).
351 // Coefficients computed by Sollya fpminimax. Max polynomial error ~1.0e-17.
352 Packet ssin = pset1<Packet>(1.59193066075142890698150587293845624470289834562208852730691432952880859375e-10);
353 ssin = pmadd(ssin, ss, pset1<Packet>(-2.50511517945670206974594627392927126408039839589037001132965087890625e-08));
354 ssin = pmadd(ssin, ss, pset1<Packet>(2.755731622544328228235042954619160582296899519860744476318359375e-06));
355 ssin = pmadd(ssin, ss, pset1<Packet>(-1.9841269837089632013978068858506276228581555187702178955078125e-04));
356 ssin = pmadd(ssin, ss, pset1<Packet>(8.333333333331312264835588621281203813850879669189453125e-03));
357 ssin = pmadd(ssin, ss, pset1<Packet>(-0.1666666666666666574148081281236954964697360992431640625));
358 ssin = pmul(ssin, ss);
359 ssin = pmadd(ssin, s, s);
360
361 Packet poly_mask = preinterpret<Packet>(pcmp_eq(pand(q_int, cst_one), pzero(q_int)));
362
363 Packet sign_sin = pxor(x, preinterpret<Packet>(plogical_shift_left<62>(q_int)));
364 Packet sign_cos = preinterpret<Packet>(plogical_shift_left<62>(padd(q_int, cst_one)));
365 Packet sign_bit, sFinalRes;
366 if (Func == TrigFunction::Sin) {
367 sign_bit = sign_sin;
368 sFinalRes = pselect(poly_mask, ssin, scos);
369 } else if (Func == TrigFunction::Cos) {
370 sign_bit = sign_cos;
371 sFinalRes = pselect(poly_mask, scos, ssin);
372 } else if (Func == TrigFunction::Tan) {
373 sign_bit = pxor(sign_sin, sign_cos);
374 sFinalRes = pdiv(pselect(poly_mask, ssin, scos), pselect(poly_mask, scos, ssin));
375 } else if (Func == TrigFunction::SinCos) {
376 Packet peven = peven_mask(x);
377 sign_bit = pselect(peven, sign_sin, sign_cos);
378 sFinalRes = pselect(pxor(peven, poly_mask), scos, ssin);
379 }
380 sign_bit = pand(sign_bit, cst_sign_mask); // clear all but left most bit
381 sFinalRes = pxor(sFinalRes, sign_bit);
382
383 // For inputs above huge_th the medium-path reduction loses too much precision. A vectorized
384 // Payne-Hanek reduction was investigated and judged not worthwhile (high implementation cost
385 // for what is in practice a rare path), so these inputs fall back to the scalar libm.
386 if (EIGEN_PREDICT_FALSE(predux_any(pcmp_le(pset1<Packet>(huge_th), x_abs)))) {
387 const int PacketSize = unpacket_traits<Packet>::size;
388 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) double sincos_vals[PacketSize];
389 EIGEN_ALIGN_TO_BOUNDARY(unpacket_traits<Packet>::alignment) double x_cpy[PacketSize];
390 pstoreu(x_cpy, x);
391 pstoreu(sincos_vals, sFinalRes);
392 for (int k = 0; k < PacketSize; ++k) {
393 double val = x_cpy[k];
394 if (numext::abs(val) > huge_th && (numext::isfinite)(val)) {
395 if (Func == TrigFunction::Sin) {
396 sincos_vals[k] = numext::sin(val);
397 } else if (Func == TrigFunction::Cos) {
398 sincos_vals[k] = numext::cos(val);
399 } else if (Func == TrigFunction::Tan) {
400 sincos_vals[k] = numext::tan(val);
401 } else if (Func == TrigFunction::SinCos) {
402 sincos_vals[k] = k % 2 == 0 ? numext::sin(val) : numext::cos(val);
403 }
404 }
405 }
406 sFinalRes = ploadu<Packet>(sincos_vals);
407 }
408 return sFinalRes;
409}
410
411template <typename Packet>
412EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet psin_double(const Packet& x) {
413 return psincos_double<TrigFunction::Sin>(x);
414}
415
416template <typename Packet>
417EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pcos_double(const Packet& x) {
418 return psincos_double<TrigFunction::Cos>(x);
419}
420
421template <typename Packet>
422EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet ptan_double(const Packet& x) {
423 return psincos_double<TrigFunction::Tan>(x);
424}
425
426template <typename Packet>
427EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS
428 std::enable_if_t<std::is_same<typename unpacket_traits<Packet>::type, float>::value, Packet>
429 psincos_selector(const Packet& x) {
430 return psincos_float<TrigFunction::SinCos, Packet>(x);
431}
432
433template <typename Packet>
434EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS
435 std::enable_if_t<std::is_same<typename unpacket_traits<Packet>::type, double>::value, Packet>
436 psincos_selector(const Packet& x) {
437 return psincos_double<TrigFunction::SinCos, Packet>(x);
438}
439
440//----------------------------------------------------------------------
441// Inverse Trigonometric Functions
442//----------------------------------------------------------------------
443
444// Generic implementation of acos(x).
445template <typename Packet>
446EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pacos_float(const Packet& x_in) {
447 using Scalar = typename unpacket_traits<Packet>::type;
448 static_assert(std::is_same<Scalar, float>::value, "Scalar type must be float");
449
450 const Packet cst_one = pset1<Packet>(Scalar(1));
451 const Packet cst_pi = pset1<Packet>(Scalar(EIGEN_PI));
452 const Packet p6 = pset1<Packet>(Scalar(2.36423197202384471893310546875e-3));
453 const Packet p5 = pset1<Packet>(Scalar(-1.1368644423782825469970703125e-2));
454 const Packet p4 = pset1<Packet>(Scalar(2.717843465507030487060546875e-2));
455 const Packet p3 = pset1<Packet>(Scalar(-4.8969544470310211181640625e-2));
456 const Packet p2 = pset1<Packet>(Scalar(8.8804088532924652099609375e-2));
457 const Packet p1 = pset1<Packet>(Scalar(-0.214591205120086669921875));
458 const Packet p0 = pset1<Packet>(Scalar(1.57079637050628662109375));
459
460 // For x in [0:1], we approximate acos(x)/sqrt(1-x), which is a smooth
461 // function, by a 6'th order polynomial.
462 // For x in [-1:0) we use that acos(-x) = pi - acos(x).
463 const Packet neg_mask = psignbit(x_in);
464 const Packet abs_x = pabs(x_in);
465
466 // Evaluate the polynomial using Horner's rule:
467 // P(x) = p0 + x * (p1 + x * (p2 + ... (p5 + x * p6)) ... ) .
468 // We evaluate even and odd terms independently to increase
469 // instruction level parallelism.
470 Packet x2 = pmul(x_in, x_in);
471 Packet p_even = pmadd(p6, x2, p4);
472 Packet p_odd = pmadd(p5, x2, p3);
473 p_even = pmadd(p_even, x2, p2);
474 p_odd = pmadd(p_odd, x2, p1);
475 p_even = pmadd(p_even, x2, p0);
476 Packet p = pmadd(p_odd, abs_x, p_even);
477
478 // The polynomial approximates acos(x)/sqrt(1-x), so
479 // multiply by sqrt(1-x) to get acos(x).
480 // Conveniently returns NaN for arguments outside [-1:1].
481 Packet denom = psqrt(psub(cst_one, abs_x));
482 Packet result = pmul(denom, p);
483 // Undo mapping for negative arguments.
484 return pselect(neg_mask, psub(cst_pi, result), result);
485}
486
487// Generic implementation of asin(x).
488template <typename Packet>
489EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pasin_float(const Packet& x_in) {
490 using Scalar = typename unpacket_traits<Packet>::type;
491 static_assert(std::is_same<Scalar, float>::value, "Scalar type must be float");
492
493 constexpr float kPiOverTwo = static_cast<float>(EIGEN_PI / 2);
494
495 const Packet cst_half = pset1<Packet>(0.5f);
496 const Packet cst_one = pset1<Packet>(1.0f);
497 const Packet cst_two = pset1<Packet>(2.0f);
498 const Packet cst_pi_over_two = pset1<Packet>(kPiOverTwo);
499
500 const Packet abs_x = pabs(x_in);
501 const Packet sign_mask = pandnot(x_in, abs_x);
502 const Packet invalid_mask = pcmp_lt(cst_one, abs_x);
503
504 // For arguments |x| > 0.5, we map x back to [0:0.5] using
505 // the transformation x_large = sqrt(0.5*(1-x)), and use the
506 // identity
507 // asin(x) = pi/2 - 2 * asin( sqrt( 0.5 * (1 - x)))
508
509 const Packet x_large = psqrt(pnmadd(cst_half, abs_x, cst_half));
510 const Packet large_mask = pcmp_lt(cst_half, abs_x);
511 const Packet x = pselect(large_mask, x_large, abs_x);
512 const Packet x2 = pmul(x, x);
513
514 // For |x| < 0.5 approximate asin(x)/x by an 8th order polynomial with
515 // even terms only.
516 constexpr float alpha[] = {5.08838854730129241943359375e-2f, 3.95139865577220916748046875e-2f,
517 7.550220191478729248046875e-2f, 0.16664917767047882080078125f, 1.00000011920928955078125f};
518 Packet p = ppolevl<Packet, 4>::run(x2, alpha);
519 p = pmul(p, x);
520
521 const Packet p_large = pnmadd(cst_two, p, cst_pi_over_two);
522 p = pselect(large_mask, p_large, p);
523 // Flip the sign for negative arguments.
524 p = pxor(p, sign_mask);
525 // Return NaN for arguments outside [-1:1].
526 return por(invalid_mask, p);
527}
528
529template <typename Scalar>
530struct patan_reduced {
531 template <typename Packet>
532 static EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet run(const Packet& x);
533};
534
535template <>
536template <typename Packet>
537EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet patan_reduced<double>::run(const Packet& x) {
538 constexpr double alpha[] = {2.6667153866462208e-05, 3.0917513112462781e-03, 5.2574296781008604e-02,
539 3.0409318473444424e-01, 7.5365702534987022e-01, 8.2704055405494614e-01,
540 3.3004361289279920e-01};
541
542 constexpr double beta[] = {
543 2.7311202462436667e-04, 1.0899150928962708e-02, 1.1548932646420353e-01, 4.9716458728465573e-01, 1.0,
544 9.3705509168587852e-01, 3.3004361289279920e-01};
545
546 Packet x2 = pmul(x, x);
547 Packet p = ppolevl<Packet, 6>::run(x2, alpha);
548 Packet q = ppolevl<Packet, 6>::run(x2, beta);
549 return pmul(x, pdiv(p, q));
550}
551
552// Computes elementwise atan(x) for x in [-1:1] with 2 ulp accuracy.
553template <>
554template <typename Packet>
555EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet patan_reduced<float>::run(const Packet& x) {
556 constexpr float alpha[] = {1.12026982009410858154296875e-01f, 7.296695709228515625e-01f, 8.109951019287109375e-01f};
557
558 constexpr float beta[] = {1.00917108356952667236328125e-02f, 2.8318560123443603515625e-01f, 1.0f,
559 8.109951019287109375e-01f};
560
561 Packet x2 = pmul(x, x);
562 Packet p = ppolevl<Packet, 2>::run(x2, alpha);
563 Packet q = ppolevl<Packet, 3>::run(x2, beta);
564 return pmul(x, pdiv(p, q));
565}
566
567template <typename Packet>
568EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet generic_atan(const Packet& x_in) {
569 using Scalar = typename unpacket_traits<Packet>::type;
570
571 constexpr Scalar kPiOverTwo = static_cast<Scalar>(EIGEN_PI / 2);
572
573 const Packet cst_signmask = psignmask<Packet>();
574 const Packet cst_one = pset1<Packet>(Scalar(1));
575 const Packet cst_pi_over_two = pset1<Packet>(kPiOverTwo);
576
577 // "Large": For |x| > 1, use atan(1/x) = sign(x)*pi/2 - atan(x).
578 // "Small": For |x| <= 1, approximate atan(x) directly by a polynomial
579 // calculated using Rminimax.
580
581 const Packet abs_x = pabs(x_in);
582 const Packet x_signmask = pand(x_in, cst_signmask);
583 const Packet large_mask = pcmp_lt(cst_one, abs_x);
584 const Packet x = pselect(large_mask, preciprocal(abs_x), abs_x);
585 const Packet p = patan_reduced<Scalar>::run(x);
586 // Apply transformations according to the range reduction masks.
587 Packet result = pselect(large_mask, psub(cst_pi_over_two, p), p);
588 // Return correct sign
589 return pxor(result, x_signmask);
590}
591
592//----------------------------------------------------------------------
593// Hyperbolic Functions
594//----------------------------------------------------------------------
595
596#ifdef EIGEN_FAST_MATH
597
607template <typename T>
608EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS T ptanh_float(const T& a_x) {
609 // Clamp the inputs to the range [-c, c] and set everything
610 // outside that range to 1.0. The value c is chosen as the smallest
611 // floating point argument such that the approximation is exactly 1.
612 // This saves clamping the value at the end.
613#ifdef EIGEN_VECTORIZE_FMA
614 const T plus_clamp = pset1<T>(8.01773357391357422f);
615 const T minus_clamp = pset1<T>(-8.01773357391357422f);
616#else
617 const T plus_clamp = pset1<T>(7.90738964080810547f);
618 const T minus_clamp = pset1<T>(-7.90738964080810547f);
619#endif
620 const T x = pmax(pmin(a_x, plus_clamp), minus_clamp);
621
622 // The following rational approximation was generated by rminimax
623 // (https://gitlab.inria.fr/sfilip/rminimax) using the following
624 // command:
625 // $ ratapprox --function="tanh(x)" --dom='[-8.67,8.67]' --num="odd"
626 // --den="even" --type="[9,8]" --numF="[SG]" --denF="[SG]" --log
627 // --output=tanhf.sollya --dispCoeff="dec"
628
629 // The monomial coefficients of the numerator polynomial (odd).
630 constexpr float alpha[] = {1.394553628e-8f, 2.102733560e-5f, 3.520756727e-3f, 1.340216100e-1f};
631
632 // The monomial coefficients of the denominator polynomial (even).
633 constexpr float beta[] = {8.015776984e-7f, 3.326951409e-4f, 2.597254514e-2f, 4.673548340e-1f, 1.0f};
634
635 // Since the polynomials are odd/even, we need x^2.
636 const T x2 = pmul(x, x);
637 const T x3 = pmul(x2, x);
638
639 T p = ppolevl<T, 3>::run(x2, alpha);
640 T q = ppolevl<T, 4>::run(x2, beta);
641 // Take advantage of the fact that the constant term in p is 1 to compute
642 // x*(x^2*p + 1) = x^3 * p + x.
643 p = pmadd(x3, p, x);
644
645 // Divide the numerator by the denominator.
646 return pdiv(p, q);
647}
648
649#else
650
660template <typename T>
661EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS T ptanh_float(const T& x) {
662 // The polynomial coefficients were computed using Rminimax:
663 // % ./ratapprox --function="tanh(x)-x" --dom='[-1.25,1.25]' --num="[x^3,x^5]" --den="even"
664 // --type="[3,4]" --numF="[SG]" --denF="[SG]" --log --dispCoeff="dec" --output=tanhf.solly
665 constexpr float alpha[] = {-1.46725140511989593505859375e-02f, -3.333333432674407958984375e-01f};
666 constexpr float beta[] = {1.570280082523822784423828125e-02, 4.4401752948760986328125e-01, 1.0f};
667 const T x2 = pmul(x, x);
668 const T x3 = pmul(x2, x);
669 const T p = ppolevl<T, 1>::run(x2, alpha);
670 const T q = ppolevl<T, 2>::run(x2, beta);
671 const T small_tanh = pmadd(x3, pdiv(p, q), x);
672
673 const T sign_mask = psignmask<T>();
674 const T abs_x = pandnot(x, sign_mask);
675 constexpr float kSmallThreshold = 1.25f;
676 const T large_mask = pcmp_lt(pset1<T>(kSmallThreshold), abs_x);
677 // Fast exit if all elements are small.
678 if (!predux_any(large_mask)) {
679 return small_tanh;
680 }
681
682 // Compute as 1 - (2 / (1 + exp(2*x)))
683 const T one = pset1<T>(1.0f);
684 const T two = pset1<T>(2.0f);
685 const T s = pexp_float<T, true>(pmul(two, abs_x));
686 const T abs_tanh = psub(one, pdiv(two, padd(s, one)));
687
688 // Handle infinite inputs and set sign bit.
689 constexpr float kHugeThreshold = 16.0f;
690 const T huge_mask = pcmp_lt(pset1<T>(kHugeThreshold), abs_x);
691 const T x_sign = pand(sign_mask, x);
692 const T large_tanh = por(x_sign, pselect(huge_mask, one, abs_tanh));
693 return pselect(large_mask, large_tanh, small_tanh);
694}
695
696#endif // EIGEN_FAST_MATH
697
707template <typename T>
708EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS T ptanh_double(const T& a_x) {
709 // Clamp the inputs to the range [-c, c] and set everything
710 // outside that range to 1.0. The value c is chosen as the smallest
711 // floating point argument such that the approximation is exactly 1.
712 // This saves clamping the value at the end.
713#ifdef EIGEN_VECTORIZE_FMA
714 const T plus_clamp = pset1<T>(17.6610191624600077);
715 const T minus_clamp = pset1<T>(-17.6610191624600077);
716#else
717 const T plus_clamp = pset1<T>(17.714196154005176);
718 const T minus_clamp = pset1<T>(-17.714196154005176);
719#endif
720 const T x = pmax(pmin(a_x, plus_clamp), minus_clamp);
721 // The following rational approximation was generated by rminimax
722 // (https://gitlab.inria.fr/sfilip/rminimax) using the following
723 // command:
724 // $ ./ratapprox --function="tanh(x)" --dom='[-18.72,18.72]'
725 // --num="odd" --den="even" --type="[19,18]" --numF="[D]"
726 // --denF="[D]" --log --output=tanh.sollya --dispCoeff="dec"
727
728 // The monomial coefficients of the numerator polynomial (odd).
729 constexpr double alpha[] = {2.6158007860482230e-23, 7.6534862268749319e-19, 3.1309488231386680e-15,
730 4.2303918148209176e-12, 2.4618379131293676e-09, 6.8644367682497074e-07,
731 9.3839087674268880e-05, 5.9809711724441161e-03, 1.5184719640284322e-01};
732
733 // The monomial coefficients of the denominator polynomial (even).
734 constexpr double beta[] = {6.463747022670968018e-21, 5.782506856739003571e-17,
735 1.293019623712687916e-13, 1.123643448069621992e-10,
736 4.492975677839633985e-08, 8.785185266237658698e-06,
737 8.295161192716231542e-04, 3.437448108450402717e-02,
738 4.851805297361760360e-01, 1.0};
739
740 // Since the polynomials are odd/even, we need x^2.
741 const T x2 = pmul(x, x);
742 const T x3 = pmul(x2, x);
743
744 // Interleave the evaluation of the numerator polynomial p and
745 // denominator polynomial q.
746 T p = ppolevl<T, 8>::run(x2, alpha);
747 T q = ppolevl<T, 9>::run(x2, beta);
748 // Take advantage of the fact that the constant term in p is 1 to compute
749 // x*(x^2*p + 1) = x^3 * p + x.
750 p = pmadd(x3, p, x);
751
752 // Divide the numerator by the denominator.
753 return pdiv(p, q);
754}
755
756template <typename Packet>
757EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet patanh_float(const Packet& x) {
758 using Scalar = typename unpacket_traits<Packet>::type;
759 static_assert(std::is_same<Scalar, float>::value, "Scalar type must be float");
760
761 // For |x| in [0:0.5] we use a polynomial approximation of the form
762 // P(x) = x + x^3*(alpha[4] + x^2 * (alpha[3] + x^2 * (... x^2 * alpha[0]) ... )).
763 constexpr float alpha[] = {0.1819281280040740966796875f, 8.2311116158962249755859375e-2f,
764 0.14672131836414337158203125f, 0.1997792422771453857421875f, 0.3333373963832855224609375f};
765 const Packet x2 = pmul(x, x);
766 const Packet x3 = pmul(x, x2);
767 Packet p = ppolevl<Packet, 4>::run(x2, alpha);
768 p = pmadd(x3, p, x);
769
770 const Packet half = pset1<Packet>(0.5f);
771 const Packet one = pset1<Packet>(1.0f);
772 const Packet x_gt_half = pcmp_le(half, pabs(x));
773 // Fast exit: if all |x| <= 0.5, skip the expensive plog/pdiv branch.
774 if (!predux_any(x_gt_half)) {
775 return p;
776 }
777
778 // For |x| in ]0.5:1.0] we use atanh = 0.5*ln((1+x)/(1-x));
779 Packet r = pdiv(padd(one, x), psub(one, x));
780 r = pmul(half, plog(r));
781
782 const Packet x_eq_one = pcmp_eq(one, pabs(x));
783 const Packet x_gt_one = pcmp_lt(one, pabs(x));
784 const Packet sign_mask = psignmask<Packet>();
785 const Packet x_sign = pand(sign_mask, x);
786 const Packet inf = pinf<Packet>();
787 return por(x_gt_one, pselect(x_eq_one, por(x_sign, inf), pselect(x_gt_half, r, p)));
788}
789
790template <typename Packet>
791EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet patanh_double(const Packet& x) {
792 using Scalar = typename unpacket_traits<Packet>::type;
793 static_assert(std::is_same<Scalar, double>::value, "Scalar type must be double");
794 // For x in [-0.5:0.5] we use a rational approximation of the form
795 // R(x) = x + x^3*P(x^2)/Q(x^2), where P is or order 4 and Q is of order 5.
796 constexpr double alpha[] = {3.3071338469301391e-03, -4.7129526768798737e-02, 1.8185306179826699e-01,
797 -2.5949536095445679e-01, 1.2306328729812676e-01};
798
799 constexpr double beta[] = {-3.8679974580640881e-03, 7.6391885763341910e-02, -4.2828141436397615e-01,
800 9.8733495886883648e-01, -1.0000000000000000e+00, 3.6918986189438030e-01};
801
802 const Packet x2 = pmul(x, x);
803 const Packet x3 = pmul(x, x2);
804 Packet p = ppolevl<Packet, 4>::run(x2, alpha);
805 Packet q = ppolevl<Packet, 5>::run(x2, beta);
806 Packet y_small = pmadd(x3, pdiv(p, q), x);
807
808 const Packet half = pset1<Packet>(0.5);
809 const Packet one = pset1<Packet>(1.0);
810 const Packet x_gt_half = pcmp_le(half, pabs(x));
811 // Fast exit: if all |x| <= 0.5, skip the expensive plog/pdiv branch.
812 if (!predux_any(x_gt_half)) {
813 return y_small;
814 }
815
816 // For |x| in ]0.5:1.0] we use atanh = 0.5*ln((1+x)/(1-x));
817 Packet y_large = pdiv(padd(one, x), psub(one, x));
818 y_large = pmul(half, plog(y_large));
819
820 const Packet x_eq_one = pcmp_eq(one, pabs(x));
821 const Packet x_gt_one = pcmp_lt(one, pabs(x));
822 const Packet sign_mask = psignmask<Packet>();
823 const Packet x_sign = pand(sign_mask, x);
824 const Packet inf = pinf<Packet>();
825 return por(x_gt_one, pselect(x_eq_one, por(x_sign, inf), pselect(x_gt_half, y_large, y_small)));
826}
827
828//----------------------------------------------------------------------
829// sinh / cosh
830//----------------------------------------------------------------------
831
839template <typename Packet>
840EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet psinh_float(const Packet& x) {
841 using Scalar = typename unpacket_traits<Packet>::type;
842 static_assert(std::is_same<Scalar, float>::value, "Scalar type must be float");
843
844 const Packet sign_mask = psignmask<Packet>();
845 const Packet abs_x = pandnot(x, sign_mask);
846 const Packet x_sign = pand(x, sign_mask);
847
848 // For |x| < 1, use a polynomial approximation to avoid
849 // cancellation in exp(x) - exp(-x).
850 constexpr float alpha[] = {2.7557314045e-06f, 1.9841270114e-04f, 8.3333335817e-03f, 1.6666666716e-01f};
851 const Packet x2 = pmul(x, x);
852 Packet p_small = ppolevl<Packet, 3>::run(x2, alpha);
853 p_small = pmadd(pmul(x2, x), p_small, x);
854
855 // Compute e = exp(|x|) / 2 = exp(|x| - 1) * (e/2), where e is Euler's number.
856 // Using a single exp avoids a second expensive call, and subtracting 1 (exactly
857 // representable) instead of ln2 avoids rounding error in the argument to exp,
858 // which would be amplified into large relative output error.
859 const Packet half_e = pset1<Packet>(1.3591409142295225f); // e/2
860 const Packet one = pset1<Packet>(1.0f);
861 const Packet e = pmul(pexp(psub(abs_x, one)), half_e);
862
863 // Medium path (1 <= |x| <= 20):
864 // sinh(x) = (exp(|x|) - exp(-|x|)) / 2
865 // = (2*e - 1/(2*e)) / 2 = e - 1/(4*e)
866 const Packet quarter = pset1<Packet>(0.25f);
867 Packet p_medium = psub(e, pdiv(quarter, e));
868
869 // Large path (|x| > 20): exp(-|x|) is negligible, sinh(x) ~ exp(|x|)/2 = e.
870 const Packet large_threshold = pset1<Packet>(20.0f);
871 const Packet large_mask = pcmp_lt(large_threshold, abs_x);
872 Packet p_large = pselect(large_mask, e, p_medium);
873 p_large = por(x_sign, p_large);
874
875 const Packet small_mask = pcmp_lt(abs_x, one);
876 return pselect(small_mask, p_small, p_large);
877}
878
879template <typename Packet>
880EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet psinh_double(const Packet& x) {
881 using Scalar = typename unpacket_traits<Packet>::type;
882 static_assert(std::is_same<Scalar, double>::value, "Scalar type must be double");
883
884 const Packet sign_mask = psignmask<Packet>();
885 const Packet abs_x = pandnot(x, sign_mask);
886 const Packet x_sign = pand(x, sign_mask);
887
888 // Taylor series: sinh(x) = x + x^3/3! + x^5/5! + ... + x^19/19!
889 // Polynomial form: sinh(x) = x + x^3 * P(x^2) where P(t) = sum_{k=0}^{8} t^k/(2k+3)!
890 // ppolevl stores highest-degree coefficient first.
891 constexpr double alpha[] = {
892 8.2206352466243297e-18, // t^8: 1/19!
893 2.8114572543455206e-15, // t^7: 1/17!
894 7.6471637318198164e-13, // t^6: 1/15!
895 1.6059043836821613e-10, // t^5: 1/13!
896 2.5052108385441718e-08, // t^4: 1/11!
897 2.7557319223985893e-06, // t^3: 1/9!
898 1.9841269841269841e-04, // t^2: 1/7!
899 8.3333333333333332e-03, // t^1: 1/5!
900 1.6666666666666666e-01, // t^0: 1/3!
901 };
902 const Packet x2 = pmul(x, x);
903 Packet p_small = ppolevl<Packet, 8>::run(x2, alpha);
904 p_small = pmadd(pmul(x2, x), p_small, x);
905
906 // Compute e = exp(|x|) / 2 = exp(|x| - 1) * (e/2), where e is Euler's number.
907 // Subtracting 1 (exactly representable) instead of ln2 avoids rounding error
908 // in the argument to exp, which would be amplified into large relative error.
909 const Packet half_e = pset1<Packet>(1.3591409142295225); // e/2
910 const Packet one = pset1<Packet>(1.0);
911 const Packet e = pmul(pexp(psub(abs_x, one)), half_e);
912
913 // Medium path (1 <= |x| <= 20):
914 // sinh(x) = (exp(|x|) - exp(-|x|)) / 2 = e - 1/(4*e)
915 const Packet quarter = pset1<Packet>(0.25);
916 Packet p_medium = psub(e, pdiv(quarter, e));
917
918 // Large path (|x| > 20): exp(-|x|) is negligible, sinh(x) ~ exp(|x|)/2 = e.
919 const Packet large_threshold = pset1<Packet>(20.0);
920 const Packet large_mask = pcmp_lt(large_threshold, abs_x);
921 Packet p_large = pselect(large_mask, e, p_medium);
922 p_large = por(x_sign, p_large);
923 const Packet small_mask = pcmp_lt(abs_x, one);
924 return pselect(small_mask, p_small, p_large);
925}
926
933template <typename Packet>
934EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pcosh_float(const Packet& x) {
935 const Packet abs_x = pabs(x);
936
937 // Compute e = exp(|x|) / 2 = exp(|x| - 1) * (e/2), where e is Euler's number.
938 // Using a single exp avoids a second expensive call, and subtracting 1 (exactly
939 // representable) instead of ln2 avoids rounding error in the argument to exp,
940 // which would be amplified into large relative output error.
941 const Packet half_e = pset1<Packet>(1.3591409142295225f); // e/2
942 const Packet one = pset1<Packet>(1.0f);
943 const Packet e = pmul(pexp(psub(abs_x, one)), half_e);
944
945 // Medium path: cosh(x) = (exp(|x|) + exp(-|x|)) / 2
946 // = (2*e + 1/(2*e)) / 2 = e + 1/(4*e)
947 const Packet quarter = pset1<Packet>(0.25f);
948 Packet p_medium = padd(e, pdiv(quarter, e));
949
950 // Large path (|x| > 20): exp(-|x|) is negligible, cosh(x) ~ exp(|x|)/2 = e.
951 const Packet large_threshold = pset1<Packet>(20.0f);
952 const Packet large_mask = pcmp_lt(large_threshold, abs_x);
953 return pselect(large_mask, e, p_medium);
954}
955
956template <typename Packet>
957EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pcosh_double(const Packet& x) {
958 const Packet abs_x = pabs(x);
959
960 // Compute e = exp(|x|) / 2 = exp(|x| - 1) * (e/2), where e is Euler's number.
961 // Subtracting 1 (exactly representable) instead of ln2 avoids rounding error
962 // in the argument to exp, which would be amplified into large relative error.
963 const Packet half_e = pset1<Packet>(1.3591409142295225); // e/2
964 const Packet one = pset1<Packet>(1.0);
965 const Packet e = pmul(pexp(psub(abs_x, one)), half_e);
966
967 // Medium path: cosh(x) = (exp(|x|) + exp(-|x|)) / 2 = e + 1/(4*e)
968 const Packet quarter = pset1<Packet>(0.25);
969 Packet p_medium = padd(e, pdiv(quarter, e));
970
971 // Large path (|x| > 20): exp(-|x|) is negligible, cosh(x) ~ exp(|x|)/2 = e.
972 const Packet large_threshold = pset1<Packet>(20.0);
973 const Packet large_mask = pcmp_lt(large_threshold, abs_x);
974 return pselect(large_mask, e, p_medium);
975}
976
977//----------------------------------------------------------------------
978// asinh / acosh
979//----------------------------------------------------------------------
980
986template <typename Packet>
987EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pasinh_float(const Packet& x) {
988 const Packet sign_mask = psignmask<Packet>();
989 const Packet abs_x = pandnot(x, sign_mask);
990 const Packet x_sign = pand(x, sign_mask);
991 const Packet one = pset1<Packet>(1.0f);
992
993 // For |x| >= 1e10, use log(2|x|) = log1p(|x| - 1) + ln2 to avoid x^2 overflow.
994 const Packet large_mask = pcmp_lt(pset1<Packet>(1e10f), abs_x);
995 // Guard x^2 against overflow in the large case.
996 const Packet x2 = pmul(abs_x, pselect(large_mask, pzero(abs_x), abs_x));
997 // For |x| < 1e10: log1p(|x| + x^2 / (1 + sqrt(1 + x^2))).
998 // Algebraically equivalent to log(|x| + sqrt(x^2 + 1))
999 // but avoids cancellation for small |x|.
1000 Packet normal_arg = padd(abs_x, pdiv(x2, padd(one, psqrt(padd(one, x2)))));
1001 // For |x| >= 1e10: log1p(|x| - 1), then add ln2 after.
1002 Packet large_arg = psub(abs_x, one);
1003 // Select argument, then call log1p once.
1004 Packet result = generic_log1p(pselect(large_mask, large_arg, normal_arg));
1005 // Add ln2 for the large path: log(2|x|) = log(|x|) + ln2 = log1p(|x|-1) + ln2.
1006 const Packet ln2 = pset1<Packet>(0.6931471805599453f);
1007 result = pselect(large_mask, padd(result, ln2), result);
1008 return por(x_sign, result);
1009}
1010
1011template <typename Packet>
1012EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pasinh_double(const Packet& x) {
1013 const Packet sign_mask = psignmask<Packet>();
1014 const Packet abs_x = pandnot(x, sign_mask);
1015 const Packet x_sign = pand(x, sign_mask);
1016 const Packet one = pset1<Packet>(1.0);
1017
1018 const Packet large_mask = pcmp_lt(pset1<Packet>(1e150), abs_x);
1019 const Packet x2 = pmul(abs_x, pselect(large_mask, pzero(abs_x), abs_x));
1020 Packet normal_arg = padd(abs_x, pdiv(x2, padd(one, psqrt(padd(one, x2)))));
1021 Packet large_arg = psub(abs_x, one);
1022 Packet result = generic_log1p(pselect(large_mask, large_arg, normal_arg));
1023 const Packet ln2 = pset1<Packet>(0.6931471805599453);
1024 result = pselect(large_mask, padd(result, ln2), result);
1025 return por(x_sign, result);
1026}
1027
1034template <typename Packet>
1035EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pacosh_float(const Packet& x) {
1036 const Packet one = pset1<Packet>(1.0f);
1037 const Packet two = pset1<Packet>(2.0f);
1038 const Packet t = psub(x, one);
1039 const Packet huge_mask = pcmp_lt(pset1<Packet>(1e10f), x);
1040 // Guard t*(t+2) against overflow in the huge case.
1041 const Packet t_tp2 = pmul(pselect(huge_mask, pzero(t), t), padd(t, two));
1042 Packet normal_arg = padd(t, psqrt(t_tp2));
1043 // For huge x: acosh(x) = log(2x) = log1p(x - 1) + ln2.
1044 Packet huge_arg = t;
1045 // Select argument, then call log1p once.
1046 Packet result = generic_log1p(pselect(huge_mask, huge_arg, normal_arg));
1047 const Packet ln2 = pset1<Packet>(0.6931471805599453f);
1048 result = pselect(huge_mask, padd(result, ln2), result);
1049 // Return NaN for x < 1.
1050 const Packet invalid_mask = pcmp_lt(x, one);
1051 return por(invalid_mask, result);
1052}
1053
1054template <typename Packet>
1055EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS Packet pacosh_double(const Packet& x) {
1056 const Packet one = pset1<Packet>(1.0);
1057 const Packet two = pset1<Packet>(2.0);
1058 const Packet t = psub(x, one);
1059 const Packet huge_mask = pcmp_lt(pset1<Packet>(1e150), x);
1060 const Packet t_tp2 = pmul(pselect(huge_mask, pzero(t), t), padd(t, two));
1061 Packet normal_arg = padd(t, psqrt(t_tp2));
1062 Packet huge_arg = t;
1063 Packet result = generic_log1p(pselect(huge_mask, huge_arg, normal_arg));
1064 const Packet ln2 = pset1<Packet>(0.6931471805599453);
1065 result = pselect(huge_mask, padd(result, ln2), result);
1066 const Packet invalid_mask = pcmp_lt(x, one);
1067 return por(invalid_mask, result);
1068}
1069
1070} // end namespace internal
1071} // end namespace Eigen
1072
1073#endif // EIGEN_ARCH_GENERIC_PACKET_MATH_TRIG_H