lib/libm/man/round.3

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