xref: /freebsd/lib/msun/man/fegetround.3 (revision d0a9cc17ba44cff547c673bd3086231a68b76370)
1.\" Copyright (c) 2004 David Schultz <das@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd May 8, 2004
26.Dt FEGETROUND 3
27.Os
28.Sh NAME
29.Nm fegetround ,
30.Nm fesetround
31.Nd floating-point rounding control
32.Sh LIBRARY
33.Lb libm
34.Sh SYNOPSIS
35.In fenv.h
36.Fd "#pragma STDC FENV_ACCESS ON"
37.Ft int
38.Fn fegetround void
39.Ft int
40.Fn fesetround "int round"
41.Sh DESCRIPTION
42The
43.Fn fegetround
44function determines the current floating-point rounding mode,
45and the
46.Fn fesetround
47function sets the current rounding mode to
48.Fa round .
49The rounding mode is one of
50.Dv FE_TONEAREST , FE_DOWNWARD , FE_UPWARD ,
51or
52.Dv FE_TOWARDZERO ,
53as described in
54.Xr fenv 3 .
55.Sh RETURN VALUES
56The
57.Fn fegetround
58routine returns the current rounding mode.
59The
60.Fn fesetround
61function returns 0 on success and non-zero otherwise;
62however, the present implementation always succeeds.
63.Sh SEE ALSO
64.Xr fenv 3 ,
65.Xr fpgetround 3 ,
66.Xr fpsetround 3
67.Sh STANDARDS
68The
69.Fn fegetround
70and
71.Fn fesetround
72functions conform to
73.St -isoC-99 .
74.Sh HISTORY
75These routines first appeared in
76.Fx 5.3 .
77They supersede the non-standard
78.Xr fpgetround 3
79and
80.Xr fpsetround 3
81functions.
82