man3/lround.3

   1 .\" Copyright 2001 Andries Brouwer <aeb@cwi.nl>.
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .TH LROUND 3  2021-03-22 "" "Linux Programmer's Manual"
  28 .SH NAME
  29 lround, lroundf, lroundl, llround, llroundf, llroundl \- round to
  30 nearest integer
  31 .SH SYNOPSIS
  32 .nf
  33 .B #include <math.h>
  34 .PP
  35 .BI "long lround(double " x );
  36 .BI "long lroundf(float " x );
  37 .BI "long lroundl(long double " x );
  38 .PP
  39 .BI "long long llround(double " x );
  40 .BI "long long llroundf(float " x );
  41 .BI "long long llroundl(long double " x );
  42 .fi
  43 .PP
  44 Link with \fI\-lm\fP.
  45 .PP
  46 .RS -4
  47 Feature Test Macro Requirements for glibc (see
  48 .BR feature_test_macros (7)):
  49 .RE
  50 .PP
  51 All functions shown above:
  52 .nf
  53     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  54 .fi
  55 .SH DESCRIPTION
  56 These functions round their argument to the nearest integer value,
  57 rounding halfway cases away from zero,
  58 regardless of the current rounding direction (see
  59 .BR fenv (3)).
  60 .PP
  61 Note that unlike the
  62 .BR round (3)
  63 and
  64 .BR ceil (3),
  65 functions, the return type of these functions differs from
  66 that of their arguments.
  67 .SH RETURN VALUE
  68 These functions return the rounded integer value.
  69 .PP
  70 If
  71 .I x
  72 is a NaN or an infinity,
  73 or the rounded value is too large to be stored in a
  74 .I long
  75 .RI ( "long long"
  76 in the case of the
  77 .B ll*
  78 functions),
  79 then a domain error occurs, and the return value is unspecified.
  80 .\" The return value is -(LONG_MAX - 1) or -(LLONG_MAX -1)
  81 .SH ERRORS
  82 See
  83 .BR math_error (7)
  84 for information on how to determine whether an error has occurred
  85 when calling these functions.
  86 .PP
  87 The following errors can occur:
  88 .TP
  89 Domain error: \fIx\fP is a NaN or infinite, or the rounded value is too large
  90 .\" .I errno
  91 .\" is set to
  92 .\" .BR EDOM .
  93 An invalid floating-point exception
  94 .RB ( FE_INVALID )
  95 is raised.
  96 .PP
  97 These functions do not set
  98 .IR errno .
  99 .\" FIXME . Is it intentional that these functions do not set errno?
 100 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6797
 101 .SH VERSIONS
 102 These functions first appeared in glibc in version 2.1.
 103 .SH ATTRIBUTES
 104 For an explanation of the terms used in this section, see
 105 .BR attributes (7).
 106 .ad l
 107 .nh
 108 .TS
 109 allbox;
 110 lbx lb lb
 111 l l l.
 112 Interface       Attribute       Value
 113 T{
 114 .BR lround (),
 115 .BR lroundf (),
 116 .BR lroundl (),
 117 .BR llround (),
 118 .BR llroundf (),
 119 .BR llroundl ()
 120 T}      Thread safety   MT-Safe
 121 .TE
 122 .hy
 123 .ad
 124 .sp 1
 125 .SH CONFORMING TO
 126 C99, POSIX.1-2001, POSIX.1-2008.
 127 .SH SEE ALSO
 128 .BR ceil (3),
 129 .BR floor (3),
 130 .BR lrint (3),
 131 .BR nearbyint (3),
 132 .BR rint (3),
 133 .BR round (3)