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