summaryrefslogtreecommitdiffstats
path: root/lib/libm/man/feenableexcept.3
diff options
context:
space:
mode:
authormartynas <martynas@openbsd.org>2011-05-25 21:28:43 +0000
committermartynas <martynas@openbsd.org>2011-05-25 21:28:43 +0000
commit939fdbfbefbedcc482706073c233c6a468ca2169 (patch)
tree3bd709d8b20f1a72bf52e3d4309828ff2a949f17 /lib/libm/man/feenableexcept.3
parentOn PowerPC we cannot manipulate FPSCR[VX]--it's a summary of all (diff)
downloadwireguard-openbsd-939fdbfbefbedcc482706073c233c6a468ca2169.tar.xz
wireguard-openbsd-939fdbfbefbedcc482706073c233c6a468ca2169.zip
Document C99 floating-point environment.
Diffstat (limited to 'lib/libm/man/feenableexcept.3')
-rw-r--r--lib/libm/man/feenableexcept.387
1 files changed, 87 insertions, 0 deletions
diff --git a/lib/libm/man/feenableexcept.3 b/lib/libm/man/feenableexcept.3
new file mode 100644
index 00000000000..d550c6575eb
--- /dev/null
+++ b/lib/libm/man/feenableexcept.3
@@ -0,0 +1,87 @@
+.\" $OpenBSD: feenableexcept.3,v 1.1 2011/05/25 21:28:43 martynas Exp $
+.\"
+.\" Copyright (c) 2011 Martynas Venckus <martynas@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: May 25 2011 $
+.Dt FEENABLEEXCEPT 3
+.Os
+.Sh NAME
+.Nm feenableexcept ,
+.Nm fedisableexcept ,
+.Nm fegetexcept
+.Nd control floating-point exception masks
+.Sh SYNOPSIS
+.Fd #include <fenv.h>
+.Ft int
+.Fn feenableexcept "int excepts"
+.Ft int
+.Fn fedisableexcept "int excepts"
+.Ft int
+.Fn fegetexcept void
+.Sh DESCRIPTION
+These functions provide control of the floating-point exception
+masks.
+The
+.Fa excepts
+input argument is a bitmask specifying an exception type and
+containing any of the values listed in
+.Xr feclearexcept 3 .
+.El
+.Pp
+The
+.Fn feenableexcept
+function unmasks the floating-point exceptions represented by
+.Fa excepts .
+The future floating-point operations that produce
+.Fa excepts
+will trap, and a
+.Dv SIGFPE
+will be delivered to the process.
+.Pp
+The
+.Fn fedisableexcept
+function masks the floating-point exceptions represented by
+.Fa excepts .
+All exceptions are masked by default.
+.Pp
+The
+.Fn fegetexcept
+function returns the current exception mask.
+.Sh RETURN VALUES
+The
+.Fn feenableexcept ,
+and
+.Fn fedisableexcept
+functions return the previous exception mask.
+The
+.Fn fegetexcept
+function returns the current exception mask.
+.Sh SEE ALSO
+.Xr sigaction 2 ,
+.Xr feclearexcept 3 ,
+.Xr fegetround 3 ,
+.Xr fegetenv 3
+.Sh STANDARDS
+The
+.Fn feenableexcept ,
+.Fn fedisableexcept ,
+and
+.Fn fegetexcept
+functions are
+.Ox
+extensions.
+.Sh HISTORY
+These functions first appeared in
+.Ox 5.0 .