xref: /openbsd-src/lib/libm/man/feenableexcept.3 (revision 86f9d4cdda0e0267dccd8755ac0035525579c4a7)
1*86f9d4cdStedu.\"	$OpenBSD: feenableexcept.3,v 1.3 2013/06/05 03:40:26 tedu Exp $
2939fdbfbSmartynas.\"
3939fdbfbSmartynas.\" Copyright (c) 2011 Martynas Venckus <martynas@openbsd.org>
4939fdbfbSmartynas.\"
5939fdbfbSmartynas.\" Permission to use, copy, modify, and distribute this software for any
6939fdbfbSmartynas.\" purpose with or without fee is hereby granted, provided that the above
7939fdbfbSmartynas.\" copyright notice and this permission notice appear in all copies.
8939fdbfbSmartynas.\"
9939fdbfbSmartynas.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10939fdbfbSmartynas.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11939fdbfbSmartynas.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12939fdbfbSmartynas.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13939fdbfbSmartynas.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14939fdbfbSmartynas.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15939fdbfbSmartynas.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16939fdbfbSmartynas.\"
17*86f9d4cdStedu.Dd $Mdocdate: June 5 2013 $
18939fdbfbSmartynas.Dt FEENABLEEXCEPT 3
19939fdbfbSmartynas.Os
20939fdbfbSmartynas.Sh NAME
21939fdbfbSmartynas.Nm feenableexcept ,
22939fdbfbSmartynas.Nm fedisableexcept ,
23939fdbfbSmartynas.Nm fegetexcept
24939fdbfbSmartynas.Nd control floating-point exception masks
25939fdbfbSmartynas.Sh SYNOPSIS
26*86f9d4cdStedu.In fenv.h
27939fdbfbSmartynas.Ft int
28939fdbfbSmartynas.Fn feenableexcept "int excepts"
29939fdbfbSmartynas.Ft int
30939fdbfbSmartynas.Fn fedisableexcept "int excepts"
31939fdbfbSmartynas.Ft int
32939fdbfbSmartynas.Fn fegetexcept void
33939fdbfbSmartynas.Sh DESCRIPTION
34939fdbfbSmartynasThese functions provide control of the floating-point exception
35939fdbfbSmartynasmasks.
36939fdbfbSmartynasThe
37939fdbfbSmartynas.Fa excepts
38939fdbfbSmartynasinput argument is a bitmask specifying an exception type and
39939fdbfbSmartynascontaining any of the values listed in
40939fdbfbSmartynas.Xr feclearexcept 3 .
41939fdbfbSmartynas.Pp
42939fdbfbSmartynasThe
43939fdbfbSmartynas.Fn feenableexcept
44939fdbfbSmartynasfunction unmasks the floating-point exceptions represented by
45939fdbfbSmartynas.Fa excepts .
46939fdbfbSmartynasThe future floating-point operations that produce
47939fdbfbSmartynas.Fa excepts
48939fdbfbSmartynaswill trap, and a
49939fdbfbSmartynas.Dv SIGFPE
50939fdbfbSmartynaswill be delivered to the process.
51939fdbfbSmartynas.Pp
52939fdbfbSmartynasThe
53939fdbfbSmartynas.Fn fedisableexcept
54939fdbfbSmartynasfunction masks the floating-point exceptions represented by
55939fdbfbSmartynas.Fa excepts .
56939fdbfbSmartynasAll exceptions are masked by default.
57939fdbfbSmartynas.Pp
58939fdbfbSmartynasThe
59939fdbfbSmartynas.Fn fegetexcept
60939fdbfbSmartynasfunction returns the current exception mask.
61939fdbfbSmartynas.Sh RETURN VALUES
62939fdbfbSmartynasThe
63939fdbfbSmartynas.Fn feenableexcept ,
64939fdbfbSmartynasand
65939fdbfbSmartynas.Fn fedisableexcept
66939fdbfbSmartynasfunctions return the previous exception mask.
67939fdbfbSmartynasThe
68939fdbfbSmartynas.Fn fegetexcept
69939fdbfbSmartynasfunction returns the current exception mask.
70939fdbfbSmartynas.Sh SEE ALSO
71939fdbfbSmartynas.Xr sigaction 2 ,
72939fdbfbSmartynas.Xr feclearexcept 3 ,
730fde9a44Sjmc.Xr fegetenv 3 ,
740fde9a44Sjmc.Xr fegetround 3
75939fdbfbSmartynas.Sh STANDARDS
76939fdbfbSmartynasThe
77939fdbfbSmartynas.Fn feenableexcept ,
78939fdbfbSmartynas.Fn fedisableexcept ,
79939fdbfbSmartynasand
80939fdbfbSmartynas.Fn fegetexcept
81939fdbfbSmartynasfunctions are
82939fdbfbSmartynas.Ox
83939fdbfbSmartynasextensions.
84939fdbfbSmartynas.Sh HISTORY
85939fdbfbSmartynasThese functions first appeared in
86939fdbfbSmartynas.Ox 5.0 .
87