xref: /freebsd/lib/msun/man/nextafter.3 (revision edf8578117e8844e02c0121147f45e4609b30680)
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.\"     from: @(#)ieee.3	6.4 (Berkeley) 5/6/91
29.\"
30.Dd May 4, 2005
31.Dt NEXTAFTER 3
32.Os
33.Sh NAME
34.Nm nextafter ,
35.Nm nextafterf ,
36.Nm nextafterl ,
37.Nm nexttoward ,
38.Nm nexttowardf ,
39.Nm nexttowardl
40.Nd next representable value
41.Sh LIBRARY
42.Lb libm
43.Sh SYNOPSIS
44.In math.h
45.Ft double
46.Fn nextafter "double x" "double y"
47.Ft float
48.Fn nextafterf "float x" "float y"
49.Ft long double
50.Fn nextafterl "long double x" "long double y"
51.Ft double
52.Fn nexttoward "double x" "long double y"
53.Ft float
54.Fn nexttowardf "float x" "long double y"
55.Ft long double
56.Fn nexttowardl "long double x" "long double y"
57.Sh DESCRIPTION
58These functions
59return the next machine representable number from
60.Fa x
61in direction
62.Fa y .
63.Sh SEE ALSO
64.Xr ieee 3 ,
65.Xr math 3
66.Sh STANDARDS
67The
68.Fn nextafter ,
69.Fn nextafterf ,
70.Fn nextafterl ,
71.Fn nexttoward ,
72.Fn nexttowardf ,
73and
74.Fn nexttowardl
75routines conform to
76.St -isoC-99 .
77They implement the Nextafter function recommended by
78.St -ieee754 ,
79with the extension that
80.Fn nextafter "+0.0" "-0.0"
81returns
82.Li -0.0 ,
83and
84.Fn nextafter "-0.0" "+0.0"
85returns
86.Li +0.0 .
87.Sh HISTORY
88The
89.Fn nextafter
90function appeared in
91.Bx 4.3 ,
92and
93.Fn nextafterf
94appeared in
95.Fx 2.0 .
96