xref: /freebsd/lib/msun/man/nextafter.3 (revision 87569f75a91f298c52a71823c04d41cf53c88889)
1.\" Copyright (c) 1985, 1991 Regents of the University of California.
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.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)ieee.3	6.4 (Berkeley) 5/6/91
33.\" $FreeBSD$
34.\"
35.Dd May 4, 2005
36.Dt NEXTAFTER 3
37.Os
38.Sh NAME
39.Nm nextafter ,
40.Nm nextafterf ,
41.Nm nextafterl ,
42.Nm nexttoward ,
43.Nm nexttowardf ,
44.Nm nexttowardl
45.Nd next representable value
46.Sh LIBRARY
47.Lb libm
48.Sh SYNOPSIS
49.In math.h
50.Ft double
51.Fn nextafter "double x" "double y"
52.Ft float
53.Fn nextafterf "float x" "float y"
54.Ft long double
55.Fn nextafterl "long double x" "long double y"
56.Ft double
57.Fn nexttoward "double x" "long double y"
58.Ft float
59.Fn nexttowardf "float x" "long double y"
60.Ft long double
61.Fn nexttowardl "long double x" "long double y"
62.Sh DESCRIPTION
63These functions
64return the next machine representable number from
65.Fa x
66in direction
67.Fa y .
68.Sh SEE ALSO
69.Xr ieee 3 ,
70.Xr math 3
71.Sh STANDARDS
72The
73.Fn nextafter ,
74.Fn nextafterf ,
75.Fn nextafterl ,
76.Fn nexttoward ,
77.Fn nexttowardf ,
78and
79.Fn nexttowardl
80routines conform to
81.St -isoC-99 .
82They implement the Nextafter function recommended by
83.St -ieee754 ,
84with the extension that
85.Fn nextafter +0.0, -0.0
86returns
87.Li -0.0 ,
88and
89.Fn nextafter -0.0, +0.0
90returns
91.Li +0.0 .
92.Sh HISTORY
93The
94.Fn nextafter
95function appeared in
96.Bx 4.3 ,
97and
98.Fn nextafterf
99appeared in
100.Fx 2.0 .
101