summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/feraiseexcept.3p
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3p/feraiseexcept.3p
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3p/feraiseexcept.3p')
-rw-r--r--upstream/archlinux/man3p/feraiseexcept.3p91
1 files changed, 91 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/feraiseexcept.3p b/upstream/archlinux/man3p/feraiseexcept.3p
new file mode 100644
index 00000000..661f5dfe
--- /dev/null
+++ b/upstream/archlinux/man3p/feraiseexcept.3p
@@ -0,0 +1,91 @@
+'\" et
+.TH FERAISEEXCEPT "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.SH PROLOG
+This manual page is part of the POSIX Programmer's Manual.
+The Linux implementation of this interface may differ (consult
+the corresponding Linux manual page for details of Linux behavior),
+or the interface may not be implemented on Linux.
+.\"
+.SH NAME
+feraiseexcept
+\(em raise floating-point exception
+.SH SYNOPSIS
+.LP
+.nf
+#include <fenv.h>
+.P
+int feraiseexcept(int \fIexcepts\fP);
+.fi
+.SH DESCRIPTION
+The functionality described on this reference page is aligned with the
+ISO\ C standard. Any conflict between the requirements described here and the
+ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
+.P
+The
+\fIferaiseexcept\fR()
+function shall attempt to raise the supported floating-point exceptions
+represented by the
+.IR excepts
+argument. The order in which these floating-point exceptions are raised is
+unspecified,
+except that if the
+.IR excepts
+argument represents IEC 60559 valid coincident floating-point
+exceptions for atomic operations (namely overflow and inexact,
+or underflow and inexact), then overflow or underflow shall be
+raised before inexact.
+Whether the
+\fIferaiseexcept\fR()
+function additionally raises the inexact floating-point exception
+whenever it raises the overflow or underflow floating-point exception
+is implementation-defined.
+.SH "RETURN VALUE"
+If the argument is zero or if all the specified exceptions were
+successfully raised,
+\fIferaiseexcept\fR()
+shall return zero. Otherwise, it shall return a non-zero value.
+.SH ERRORS
+No errors are defined.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+The effect is intended to be similar to that of floating-point
+exceptions raised by arithmetic operations. Hence, enabled traps for
+floating-point exceptions raised by this function are taken.
+.SH RATIONALE
+Raising overflow or underflow is allowed to also raise inexact because
+on some architectures the only practical way to raise an exception is
+to execute an instruction that has the exception as a side-effect. The
+function is not restricted to accept only valid coincident expressions
+for atomic operations, so the function can be used to raise exceptions
+accrued over several operations.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIfeclearexcept\fR\^(\|)",
+.IR "\fIfegetexceptflag\fR\^(\|)",
+.IR "\fIfetestexcept\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<fenv.h>\fP"
+.\"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1-2017, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, 2018 Edition,
+Copyright (C) 2018 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+In the event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.opengroup.org/unix/online.html .
+.PP
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .