Blame man3/nextup.3

Packit 7cfc04
.\" Copyright (C) 2016, Michael Kerrisk <mtk.manpages@gmail.com>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.TH NEXTUP 3 2017-09-15 "GNU" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
nextup, nextupf, nextupl, nextdown, nextdownf, nextdownl \-
Packit 7cfc04
return next floating-point number toward positive/negative infinity
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.BR "#define _GNU_SOURCE" "     /* See feature_test_macros(7) */"
Packit 7cfc04
.B #include <math.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "double nextup(double " x );
Packit 7cfc04
.BI "float nextupf(float " x );
Packit 7cfc04
.BI "long double nextupl(long double " x );
Packit 7cfc04
.PP
Packit 7cfc04
.BI "double nextdown(double " x );
Packit 7cfc04
.BI "float nextdownf(float " x );
Packit 7cfc04
.BI "long double nextdownl(long double " x );
Packit 7cfc04
.fi
Packit 7cfc04
.PP
Packit 7cfc04
Link with \fI\-lm\fP.
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.BR nextup (),
Packit 7cfc04
.BR nextupf (),
Packit 7cfc04
and
Packit 7cfc04
.BR nextupl ()
Packit 7cfc04
functions return the next representable floating-point number greater than
Packit 7cfc04
.IR x .
Packit 7cfc04
.PP
Packit 7cfc04
If
Packit 7cfc04
.I x
Packit 7cfc04
is the smallest representable negative number in the corresponding type,
Packit 7cfc04
these functions return \-0.
Packit 7cfc04
If
Packit 7cfc04
.I x
Packit 7cfc04
is 0, the returned value is the smallest representable positive number
Packit 7cfc04
of the corresponding type.
Packit 7cfc04
.PP
Packit 7cfc04
If
Packit 7cfc04
.I x
Packit 7cfc04
is positive infinity, the returned value is positive infinity.
Packit 7cfc04
If
Packit 7cfc04
.I x
Packit 7cfc04
is negative infinity,
Packit 7cfc04
the returned value is the largest representable finite negative number
Packit 7cfc04
of the corresponding type.
Packit 7cfc04
.PP
Packit 7cfc04
If
Packit 7cfc04
.I x
Packit 7cfc04
is Nan,
Packit 7cfc04
the returned value is NaN.
Packit 7cfc04
.PP
Packit 7cfc04
The value returned by
Packit 7cfc04
.IR nextdown(x)
Packit 7cfc04
is
Packit 7cfc04
.IR \-nextup(\-x) ,
Packit 7cfc04
and similarly for the other types.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
See DESCRIPTION.
Packit 7cfc04
.\" .SH ERRORS
Packit 7cfc04
.SH VERSIONS
Packit 7cfc04
These functions first appeared in glibc in version 2.24.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lbw36 lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR nextup (),
Packit 7cfc04
.BR nextupf (),
Packit 7cfc04
.BR nextupl (),
Packit 7cfc04
.br
Packit 7cfc04
.BR nextdown (),
Packit 7cfc04
.BR nextdownf (),
Packit 7cfc04
.BR nextdownl ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
These functions are described in
Packit 7cfc04
.IR "IEEE Std 754-2008 - Standard for Floating-Point Arithmetic"
Packit 7cfc04
and
Packit 7cfc04
.IR "ISO/IEC TS 18661".
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR nearbyint (3),
Packit 7cfc04
.BR nextafter (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.