lib/libm/man/rint.3

   1 .\" Copyright (c) 1985, 1991 Regents of the University of California.
   2 .\" 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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     from: @(#)rint.3        5.1 (Berkeley) 5/2/91
  29 .\"     $NetBSD: rint.3,v 1.12 2003/08/07 16:44:48 agc Exp $
  30 .\"     $DragonFly: src/lib/libm/man/rint.3,v 1.1 2005/07/26 21:15:20 joerg Exp $
  31 .\"
  32 .Dd November 28, 2009
  33 .Dt RINT 3
  34 .Os
  35 .Sh NAME
  36 .Nm nearbyint ,
  37 .Nm nearbyintf ,
  38 .Nm rint ,
  39 .Nm rintf
  40 .Nd round to integral value in floating-point format
  41 .Sh LIBRARY
  42 .Lb libm
  43 .Sh SYNOPSIS
  44 .In math.h
  45 .Ft double
  46 .Fn nearbyint "double x"
  47 .Ft float
  48 .Fn nearbyintf "float x"
  49 .Ft double
  50 .Fn rint "double x"
  51 .Ft float
  52 .Fn rintf "float x"
  53 .Sh DESCRIPTION
  54 The
  55 .Fn rint
  56 function returns the integral value (represented as a double precision number)
  57 nearest to
  58 .Fa x
  59 according to the prevailing rounding mode.
  60 .Pp
  61 The
  62 .Fn nearbyint
  63 and
  64 .Fn nearbyintf
  65 functions perform the same operation, except that they do not raise
  66 an inexact exception.
  67 .Sh SEE ALSO
  68 .Xr abs 3 ,
  69 .Xr ceil 3 ,
  70 .Xr fabs 3 ,
  71 .Xr floor 3 ,
  72 .Xr ieee 3 ,
  73 .Xr math 3
  74 .Sh HISTORY
  75 A
  76 .Fn rint
  77 function appeared in
  78 .At v6 .