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 .\" $DragonFly: src/lib/libm/common_source/Attic/rint.3,v 1.2 2003/06/17 04:26:50 dillon Exp $
  35 .\"
  36 .Dd December 11, 1993
  37 .Dt RINT 3
  38 .Os
  39 .Sh NAME
  40 .Nm rint
  41 .Nd round-to-closest integer functions
  42 .Sh LIBRARY
  43 .Lb libm
  44 .Sh SYNOPSIS
  45 .Fd #include <math.h>
  46 .Ft double
  47 .Fn rint "double x"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn rint
  51 function finds the integer (represented as a double precision number)
  52 nearest to
  53 .Fa x
  54 in the direction of the prevailing rounding mode.
  55 .Sh NOTES
  56 On a
  57 .Tn VAX ,
  58 .Fn rint x
  59 is equivalent to adding half to the magnitude
  60 and then rounding towards zero.
  61 .Pp
  62 In the default rounding mode, to nearest,
  63 on a machine that conforms to
  64 .Tn IEEE
  65 754,
  66 .Fn rint x
  67 is the integer nearest
  68 .Fa x
  69 with the additional stipulation
  70 that if
  71 .Li |rint(x)\-x|=1/2
  72 then
  73 .Fn rint x
  74 is even.
  75 Other rounding modes can make
  76 .Fn rint
  77 act like
  78 .Fn floor ,
  79 or like
  80 .Fn ceil ,
  81 or round towards zero.
  82 .Pp
  83 Another way to obtain an integer near
  84 .Fa x
  85 is to declare (in C)
  86 .Bd -literal -offset indent
  87 double x;\0\0\0\0 int k;\0\0\0\0k\0=\0x;
  88 .Ed
  89 .Pp
  90 Most C compilers round
  91 .Fa x
  92 towards 0 to get the integer
  93 .Fa k ,
  94 but
  95 some do otherwise.
  96 If in doubt, use
  97 .Fn floor ,
  98 .Fn ceil ,
  99 or
 100 .Fn rint
 101 first, whichever you intend.
 102 Also note that, if x is larger than
 103 .Fa k
 104 can accommodate, the value of
 105 .Fa k
 106 and the presence or absence of an integer overflow are hard to
 107 predict.
 108 .Sh SEE ALSO
 109 .Xr abs 3 ,
 110 .Xr ceil 3 ,
 111 .Xr fabs 3 ,
 112 .Xr floor 3 ,
 113 .Xr ieee 3 ,
 114 .Xr math 3
 115 .Sh HISTORY
 116 A
 117 .Fn rint
 118 function appeared in
 119 .At v6 .