lib/msun/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 .\" 4. 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 .\" $FreeBSD$
  30 .\"
  31 .Dd July 5, 2004
  32 .Dt RINT 3
  33 .Os
  34 .Sh NAME
  35 .Nm nearbyint ,
  36 .Nm nearbyintf ,
  37 .Nm rint ,
  38 .Nm rintf
  39 .Nd round to integral value in floating-point format
  40 .Sh LIBRARY
  41 .Lb libm
  42 .Sh SYNOPSIS
  43 .In math.h
  44 .Ft double
  45 .Fn nearbyint "double x"
  46 .Ft float
  47 .Fn nearbyintf "float x"
  48 .Ft double
  49 .Fn rint "double x"
  50 .Ft float
  51 .Fn rintf "float x"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn rint
  55 and the
  56 .Fn rintf
  57 functions return the integral value nearest to
  58 .Fa x
  59 according to the prevailing rounding mode.
  60 These functions raise an inexact exception when the original argument
  61 is not an exact integer.
  62 .Pp
  63 The
  64 .Fn nearbyint
  65 and
  66 .Fn nearbyintf
  67 functions perform the same operation, except that they do not raise
  68 an inexact exception.
  69 .Sh SEE ALSO
  70 .Xr abs 3 ,
  71 .Xr ceil 3 ,
  72 .Xr fabs 3 ,
  73 .Xr fenv 3 ,
  74 .Xr floor 3 ,
  75 .Xr ieee 3 ,
  76 .Xr lrint 3 ,
  77 .Xr lround 3 ,
  78 .Xr math 3 ,
  79 .Xr round 3
  80 .Sh STANDARDS
  81 The
  82 .Fn nearbyint ,
  83 .Fn nearbyintf ,
  84 .Fn rint ,
  85 and
  86 .Fn rintf
  87 functions conform to
  88 .St -isoC-99 .
  89 .Sh HISTORY
  90 A
  91 .Fn rint
  92 function appeared in
  93 .At v6 .
  94 The
  95 .Fn nearbyint
  96 and
  97 .Fn nearbyintf
  98 functions appeared in
  99 .Fx 5.3 .