contrib/openbsd_libm/man/lrint.3

   1 .\"     $OpenBSD: lrint.3,v 1.4 2011/07/07 01:34:52 martynas Exp $
   2 .\" $NetBSD: lrint.3,v 1.1 2005/09/16 15:26:47 wiz Exp $
   3 .\"
   4 .\" Copyright (c) 2005 David Schultz <das@FreeBSD.org>
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 .\" $FreeBSD: /repoman/r/ncvs/src/lib/msun/man/lrint.3,v 1.2.2.2 2005/03/01 16:18:39 brueffer Exp $
  29 .\"
  30 .Dd $Mdocdate: July 7 2011 $
  31 .Dt LRINT 3
  32 .Os
  33 .Sh NAME
  34 .Nm llrint ,
  35 .Nm llrintf ,
  36 .Nm llrintl ,
  37 .Nm lrint ,
  38 .Nm lrintf ,
  39 .Nm lrintl
  40 .Nd convert to integer
  41 .Sh SYNOPSIS
  42 .In math.h
  43 .Ft long long
  44 .Fn llrint "double x"
  45 .Ft long long
  46 .Fn llrintf "float x"
  47 .Ft long long
  48 .Fn llrintl "long double x"
  49 .Ft long
  50 .Fn lrint "double x"
  51 .Ft long
  52 .Fn lrintf "float x"
  53 .Ft long
  54 .Fn lrintl "long double x"
  55 .Sh DESCRIPTION
  56 The
  57 .Fn lrint
  58 function returns the integer nearest to its argument
  59 .Fa x
  60 according to the current rounding mode.
  61 .Pp
  62 The
  63 .Fn llrint ,
  64 .Fn llrintf ,
  65 .Fn llrintl ,
  66 .Fn lrintf ,
  67 and
  68 .Fn lrintl
  69 functions differ from
  70 .Fn lrint
  71 only in their input and output types.
  72 .Sh RETURN VALUES
  73 The
  74 .Nm llrint ,
  75 .Nm llrintf ,
  76 .Nm llrintl ,
  77 .Nm lrint ,
  78 .Nm lrintf ,
  79 and
  80 .Nm lrintl
  81 functions return the integer nearest to their argument
  82 .Fa x
  83 according to the current rounding mode.
  84 If the rounded result is too large to be represented as a
  85 .Vt long long
  86 or
  87 .Vt long
  88 value, respectively,
  89 .\" an invalid exception is raised and
  90 the return value is undefined.
  91 .\" Otherwise, if
  92 .\" .Fa x
  93 .\" is not an integer,
  94 .\" .Fn lrint
  95 .\" raises an inexact exception.
  96 .\" If
  97 .\" .Fa x
  98 .\" is too large, a range error may occur.
  99 .Sh SEE ALSO
 100 .Xr lround 3 ,
 101 .Xr rint 3
 102 .Sh STANDARDS
 103 The
 104 .Fn llrint ,
 105 .Fn llrintf ,
 106 .Fn llrintl ,
 107 .Fn lrint ,
 108 .Fn lrintf ,
 109 and
 110 .Fn lrintl
 111 functions conform to
 112 .St -isoC-99 .