summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2013/man3p/fetestexcept.3p
diff options
context:
space:
mode:
Diffstat (limited to 'man-pages-posix-2013/man3p/fetestexcept.3p')
-rw-r--r--man-pages-posix-2013/man3p/fetestexcept.3p95
1 files changed, 95 insertions, 0 deletions
diff --git a/man-pages-posix-2013/man3p/fetestexcept.3p b/man-pages-posix-2013/man3p/fetestexcept.3p
new file mode 100644
index 0000000..f2b7b1a
--- /dev/null
+++ b/man-pages-posix-2013/man3p/fetestexcept.3p
@@ -0,0 +1,95 @@
+'\" et
+.TH FETESTEXCEPT "3P" 2013 "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
+fetestexcept
+\(em test floating-point exception flags
+.SH SYNOPSIS
+.LP
+.nf
+#include <fenv.h>
+.P
+int fetestexcept(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\(hy2008 defers to the ISO\ C standard.
+.P
+The
+\fIfetestexcept\fR()
+function shall determine which of a specified subset of the
+floating-point exception flags are currently set. The
+.IR excepts
+argument specifies the floating-point status flags to be queried.
+.SH "RETURN VALUE"
+The
+\fIfetestexcept\fR()
+function shall return the value of the bitwise-inclusive OR of the
+floating-point exception macros corresponding to the currently set
+floating-point exceptions included in
+.IR excepts .
+.SH ERRORS
+No errors are defined.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+The following example calls function
+\fIf\fR()
+if an invalid exception is set, and then function
+\fIg\fR()
+if an overflow exception is set:
+.sp
+.RS 4
+.nf
+\fB
+#include <fenv.h>
+/* ... */
+{
+ #pragma STDC FENV_ACCESS ON
+ int set_excepts;
+ feclearexcept(FE_INVALID | FE_OVERFLOW);
+ // maybe raise exceptions
+ set_excepts = fetestexcept(FE_INVALID | FE_OVERFLOW);
+ if (set_excepts & FE_INVALID) f();
+ if (set_excepts & FE_OVERFLOW) g();
+ /* ... */
+}
+.fi \fR
+.P
+.RE
+.SH "APPLICATION USAGE"
+None.
+.SH RATIONALE
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIfeclearexcept\fR\^(\|)",
+.IR "\fIfegetexceptflag\fR\^(\|)",
+.IR "\fIferaiseexcept\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2008,
+.IR "\fB<fenv.h>\fP"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, Copyright (C) 2013 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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.unix.org/online.html .
+
+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 .