contrib/openbsd_libm/man/round.3

   1 .\"     $OpenBSD: round.3,v 1.5 2011/07/07 01:34:52 martynas Exp $
   2 .\" Copyright (c) 2003, Steven G. Kargl
   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 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/lib/msun/man/round.3,v 1.6 2005/06/15 19:04:04 ru Exp $
  27 .\"
  28 .Dd $Mdocdate: July 7 2011 $
  29 .Dt ROUND 3
  30 .Os
  31 .Sh NAME
  32 .Nm round ,
  33 .Nm roundf ,
  34 .Nm roundl
  35 .Nd round to nearest integral value
  36 .Sh SYNOPSIS
  37 .In math.h
  38 .Ft double
  39 .Fn round "double x"
  40 .Ft float
  41 .Fn roundf "float x"
  42 .Ft long double
  43 .Fn roundl "long double x"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn round ,
  47 .Fn roundf
  48 and
  49 .Fn roundl
  50 functions return the nearest integral value to
  51 .Fa x ;
  52 if
  53 .Fa x
  54 lies halfway between two integral values, then these
  55 functions return the integral value with the larger
  56 absolute value (i.e., they round away from zero).
  57 .Sh SEE ALSO
  58 .Xr ceil 3 ,
  59 .Xr floor 3 ,
  60 .Xr lrint 3 ,
  61 .Xr lround 3 ,
  62 .Xr nextafter 3 ,
  63 .Xr rint 3 ,
  64 .Xr trunc 3
  65 .Sh STANDARDS
  66 These functions conform to
  67 .St -isoC-99 .