lib/libm/man/round.3

   1 .\" $NetBSD: round.3,v 1.6 2011/09/13 07:11:43 njoly Exp $
   2 .\"
   3 .\" Copyright (c) 2003, Steven G. Kargl
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd December 21, 2011
  30 .Dt ROUND 3
  31 .Os
  32 .Sh NAME
  33 .Nm round ,
  34 .Nm roundf ,
  35 .Nm roundl
  36 .Nd round to nearest integral value
  37 .Sh LIBRARY
  38 .Lb libm
  39 .Sh SYNOPSIS
  40 .In math.h
  41 .Ft double
  42 .Fn round "double x"
  43 .Ft float
  44 .Fn roundf "float x"
  45 .Ft "long double"
  46 .Fn roundl "long double x"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn round ,
  50 .Fn roundf ,
  51 and
  52 .Fn roundl
  53 functions return the nearest integral value to
  54 .Fa x ;
  55 if
  56 .Fa x
  57 lies halfway between two integral values, then these
  58 functions return the integral value with the larger
  59 absolute value (i.e., they round away from zero).
  60 .Sh SEE ALSO
  61 .Xr ceil 3 ,
  62 .Xr floor 3 ,
  63 .Xr lrint 3 ,
  64 .Xr lround 3 ,
  65 .Xr math 3 ,
  66 .Xr rint 3 ,
  67 .Xr trunc 3
  68 .Sh STANDARDS
  69 These functions conform to
  70 .St -isoC-99 .
  71 .Sh HISTORY
  72 The
  73 .Fn round
  74 and
  75 .Fn roundf
  76 functions appeared in
  77 .Dx 1.3 .
  78 The
  79 .Fn roundl
  80 function appeared in
  81 .Dx 2.13 .