contrib/openbsd_libm/man/rint.3

   1 .\"     $OpenBSD: rint.3,v 1.14 2013/06/05 03:40:26 tedu Exp $
   2 .\" Copyright (c) 1985, 1991 Regents of the University of California.
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. Neither the name of the University nor the names of its contributors
  14 .\"    may be used to endorse or promote products derived from this software
  15 .\"    without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\"     from: @(#)rint.3        5.1 (Berkeley) 5/2/91
  30 .\"
  31 .Dd $Mdocdate: June 5 2013 $
  32 .Dt RINT 3
  33 .Os
  34 .Sh NAME
  35 .Nm nearbyint ,
  36 .Nm nearbyintf ,
  37 .Nm nearbyintl ,
  38 .Nm rint ,
  39 .Nm rintf ,
  40 .Nm rintl
  41 .Nd round to integral value in floating-point format
  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 long double
  49 .Fn nearbyintl "long double x"
  50 .Ft double
  51 .Fn rint "double x"
  52 .Ft float
  53 .Fn rintf "float x"
  54 .Ft long double
  55 .Fn rintl "long double x"
  56 .Sh DESCRIPTION
  57 The
  58 .Fn rint ,
  59 .Fn rintf ,
  60 and
  61 .Fn rintl
  62 functions return the integral value nearest to
  63 .Fa x
  64 according to the prevailing rounding mode.
  65 .Pp
  66 The
  67 .Fn nearbyint ,
  68 .Fn nearbyintf ,
  69 and
  70 .Fn nearbyintl
  71 functions do the same,
  72 but without raising the
  73 .Dq inexact
  74 floating-point exception.
  75 .Sh SEE ALSO
  76 .Xr abs 3 ,
  77 .Xr ceil 3 ,
  78 .Xr fabs 3 ,
  79 .Xr floor 3
  80 .Sh HISTORY
  81 A
  82 .Fn rint
  83 function appeared in
  84 .At v6 .