man3/nextup.3

   1 .\" Copyright (C) 2016, Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH NEXTUP 3 2021-03-22 "GNU" "Linux Programmer's Manual"
  26 .SH NAME
  27 nextup, nextupf, nextupl, nextdown, nextdownf, nextdownl \-
  28 return next floating-point number toward positive/negative infinity
  29 .SH SYNOPSIS
  30 .nf
  31 .BR "#define _GNU_SOURCE" "     /* See feature_test_macros(7) */"
  32 .B #include <math.h>
  33 .PP
  34 .BI "double nextup(double " x );
  35 .BI "float nextupf(float " x );
  36 .BI "long double nextupl(long double " x );
  37 .PP
  38 .BI "double nextdown(double " x );
  39 .BI "float nextdownf(float " x );
  40 .BI "long double nextdownl(long double " x );
  41 .fi
  42 .PP
  43 Link with \fI\-lm\fP.
  44 .SH DESCRIPTION
  45 The
  46 .BR nextup (),
  47 .BR nextupf (),
  48 and
  49 .BR nextupl ()
  50 functions return the next representable floating-point number greater than
  51 .IR x .
  52 .PP
  53 If
  54 .I x
  55 is the smallest representable negative number in the corresponding type,
  56 these functions return \-0.
  57 If
  58 .I x
  59 is 0, the returned value is the smallest representable positive number
  60 of the corresponding type.
  61 .PP
  62 If
  63 .I x
  64 is positive infinity, the returned value is positive infinity.
  65 If
  66 .I x
  67 is negative infinity,
  68 the returned value is the largest representable finite negative number
  69 of the corresponding type.
  70 .PP
  71 If
  72 .I x
  73 is Nan,
  74 the returned value is NaN.
  75 .PP
  76 The value returned by
  77 .IR nextdown(x)
  78 is
  79 .IR \-nextup(\-x) ,
  80 and similarly for the other types.
  81 .SH RETURN VALUE
  82 See DESCRIPTION.
  83 .\" .SH ERRORS
  84 .SH VERSIONS
  85 These functions first appeared in glibc in version 2.24.
  86 .SH ATTRIBUTES
  87 For an explanation of the terms used in this section, see
  88 .BR attributes (7).
  89 .ad l
  90 .nh
  91 .TS
  92 allbox;
  93 lbx lb lb
  94 l l l.
  95 Interface       Attribute       Value
  96 T{
  97 .BR nextup (),
  98 .BR nextupf (),
  99 .BR nextupl (),
 100 .BR nextdown (),
 101 .BR nextdownf (),
 102 .BR nextdownl ()
 103 T}      Thread safety   MT-Safe
 104 .TE
 105 .hy
 106 .ad
 107 .sp 1
 108 .SH CONFORMING TO
 109 These functions are described in
 110 .IR "IEEE Std 754-2008 - Standard for Floating-Point Arithmetic"
 111 and
 112 .IR "ISO/IEC TS 18661".
 113 .SH SEE ALSO
 114 .BR nearbyint (3),
 115 .BR nextafter (3)