aboutsummaryrefslogtreecommitdiff
path: root/math/s_rootn_template.c
diff options
context:
space:
mode:
authorJoseph Myers <josmyers@redhat.com>2025-05-14 10:51:46 +0000
committerJoseph Myers <josmyers@redhat.com>2025-05-14 10:51:46 +0000
commit06caf53adfae0c93062edd62f83eed16ab5cec0b (patch)
tree75282662b640f39f04d13b7ba79eb3e9fb79e5ea /math/s_rootn_template.c
parent36189c76fb9c0b281de23381ae5a462a7e102ee6 (diff)
downloadglibc-master.zip
glibc-master.tar.gz
glibc-master.tar.bz2
Implement C23 rootn.HEADmaster
C23 adds various <math.h> function families originally defined in TS 18661-4. Add the rootn functions, which compute the Yth root of X for integer Y (with a domain error if Y is 0, even if X is a NaN). The integer exponent has type long long int in C23; it was intmax_t in TS 18661-4, and as with other interfaces changed after their initial appearance in the TS, I don't think we need to support the original version of the interface. As with pown and compoundn, I strongly encourage searching for worst cases for ulps error for these implementations (necessarily non-exhaustively, given the size of the input space). I also expect a custom implementation for a given format could be much faster as well as more accurate, although the implementation is simpler than those for pown and compoundn. This completes adding to glibc those TS 18661-4 functions (ignoring DFP) that are included in C23. See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=118592 regarding the C23 mathematical functions (not just the TS 18661-4 ones) missing built-in functions in GCC, where such functions might usefully be added. Tested for x86_64 and x86, and with build-many-glibcs.py.
Diffstat (limited to 'math/s_rootn_template.c')
-rw-r--r--math/s_rootn_template.c81
1 files changed, 81 insertions, 0 deletions
diff --git a/math/s_rootn_template.c b/math/s_rootn_template.c
new file mode 100644
index 0000000..771a619
--- /dev/null
+++ b/math/s_rootn_template.c
@@ -0,0 +1,81 @@
+/* Return the Yth root of X for integer Y.
+ Copyright (C) 2025 Free Software Foundation, Inc.
+ This file is part of the GNU C Library.
+
+ The GNU C Library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ The GNU C Library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with the GNU C Library; if not, see
+ <https://www.gnu.org/licenses/>. */
+
+#include <errno.h>
+#include <limits.h>
+#include <math.h>
+#include <math-narrow-eval.h>
+#include <math_private.h>
+
+
+FLOAT
+M_DECL_FUNC (__rootn) (FLOAT x, long long int y)
+{
+ if (y == 0)
+ {
+ /* This is a domain error even if X is a NaN. */
+ __set_errno (EDOM);
+ return M_LIT (0.0) / M_LIT (0.0);
+ }
+ if (isnan (x))
+ return x + x;
+ if (x < 0 && (y & 1) == 0)
+ {
+ __set_errno (EDOM);
+ return (x - x) / (x - x);
+ }
+ if (isinf (x))
+ /* If X is negative, then Y is odd. */
+ return y > 0 ? x : M_LIT (1.0) / x;
+ if (x == M_LIT (0.0))
+ {
+ if (y > 0)
+ return (y & 1) == 0 ? M_LIT (0.0) : x;
+ else
+ {
+ __set_errno (ERANGE);
+ return M_LIT (1.0) / ((y & 1) == 0 ? M_LIT (0.0) : x);
+ }
+ }
+ if (y == 1)
+ return x;
+ if (y == -1)
+ {
+ /* Overflow is possible in this case (and underflow, though not
+ underflow to zero). */
+ FLOAT ret = math_narrow_eval (M_LIT (1.0) / x);
+ if (isinf (ret))
+ __set_errno (ERANGE);
+ return ret;
+ }
+ /* Now X is finite and no overflow or underflow (or results even
+ close to overflowing or underflowing) is possible. If X is
+ negative, then Y is odd; the result should have the sign of X. */
+ if (y >= 4 * M_MAX_EXP || y <= -4 * M_MAX_EXP)
+ /* No extra precision is needed in computing the exponent; it is
+ OK if Y cannot be exactly represented in type FLOAT. */
+ return M_COPYSIGN (M_SUF (__ieee754_pow) (M_FABS (x), M_LIT (1.0) / y), x);
+ /* Compute 1 / Y with extra precision. Y can be exactly represented
+ in type FLOAT. */
+ FLOAT qhi, qlo;
+ qhi = math_narrow_eval (M_LIT (1.0) / y);
+ qlo = M_SUF (fma) (-qhi, y, 1.0) / y;
+ return M_COPYSIGN (M_SUF (__ieee754_pow) (M_FABS (x), qhi)
+ * M_SUF (__ieee754_pow) (M_FABS (x), qlo), x);
+}
+declare_mgen_alias (__rootn, rootn);