lib/libm/common_source/rint.3

   1 .\" Copyright (c) 1985, 1991, 1993
   2 .\"     The Regents of the University of California.  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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)rint.3      8.2 (Berkeley) 12/11/93
  33 .\" $FreeBSD: src/lib/libm/common_source/rint.3,v 1.4.2.1 2000/04/22 16:35:48 phantom Exp $
  34 .\"
  35 .Dd December 11, 1993
  36 .Dt RINT 3
  37 .Os
  38 .Sh NAME
  39 .Nm rint
  40 .Nd round-to-closest integer functions
  41 .Sh LIBRARY
  42 .Lb libm
  43 .Sh SYNOPSIS
  44 .Fd #include <math.h>
  45 .Ft double
  46 .Fn rint "double x"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn rint
  50 function finds the integer (represented as a double precision number)
  51 nearest to
  52 .Fa x
  53 in the direction of the prevailing rounding mode.
  54 .Sh NOTES
  55 On a
  56 .Tn VAX ,
  57 .Fn rint x
  58 is equivalent to adding half to the magnitude
  59 and then rounding towards zero.
  60 .Pp
  61 In the default rounding mode, to nearest,
  62 on a machine that conforms to
  63 .Tn IEEE
  64 754,
  65 .Fn rint x
  66 is the integer nearest
  67 .Fa x
  68 with the additional stipulation
  69 that if
  70 .Li |rint(x)\-x|=1/2
  71 then
  72 .Fn rint x
  73 is even.
  74 Other rounding modes can make
  75 .Fn rint
  76 act like
  77 .Fn floor ,
  78 or like
  79 .Fn ceil ,
  80 or round towards zero.
  81 .Pp
  82 Another way to obtain an integer near
  83 .Fa x
  84 is to declare (in C)
  85 .Bd -literal -offset indent
  86 double x;\0\0\0\0 int k;\0\0\0\0k\0=\0x;
  87 .Ed
  88 .Pp
  89 Most C compilers round
  90 .Fa x
  91 towards 0 to get the integer
  92 .Fa k ,
  93 but
  94 some do otherwise.
  95 If in doubt, use
  96 .Fn floor ,
  97 .Fn ceil ,
  98 or
  99 .Fn rint
 100 first, whichever you intend.
 101 Also note that, if x is larger than
 102 .Fa k
 103 can accommodate, the value of
 104 .Fa k
 105 and the presence or absence of an integer overflow are hard to
 106 predict.
 107 .Sh SEE ALSO
 108 .Xr abs 3 ,
 109 .Xr ceil 3 ,
 110 .Xr fabs 3 ,
 111 .Xr floor 3 ,
 112 .Xr ieee 3 ,
 113 .Xr math 3
 114 .Sh HISTORY
 115 A
 116 .Fn rint
 117 function appeared in
 118 .At v6 .