usr/src/man/man3m/llrint.3m

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH llrint 3M "12 Jul 2006" "SunOS 5.11" "Mathematical Library Functions"
  12 .SH NAME
  13 llrint, llrintf, llrintl \- round to nearest integer value using current
  14 rounding direction
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  19 #include <math.h>
  20
  21 \fBlong long\fR \fBllrint\fR(\fBdouble\fR \fIx\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBlong long\fR \fBllrintf\fR(\fBfloat\fR \fIx\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBlong long\fR \fBllrintl\fR(\fBlong double\fR \fIx\fR);
  32 .fi
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 These functions round their argument to the nearest integer value, rounding
  38 according to the current rounding direction.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42  Upon successful completion, these functions return the rounded integer value.
  43 .sp
  44 .LP
  45 If \fIx\fR is NaN, a domain error occurs and an unspecified value is returned.
  46 .sp
  47 .LP
  48 If \fIx\fR is +Inf, a domain error occurs and an unspecified value is returned.
  49 .sp
  50 .LP
  51 If \fIx\fR is -Inf, a domain error occurs and an unspecified value is returned.
  52 .sp
  53 .LP
  54 If the correct value is positive and too large to represent as a \fBlong
  55 long\fR, a domain error occurs and an unspecified value is returned.
  56 .sp
  57 .LP
  58  If the correct value is negative and too large to represent as a \fBlong
  59 long\fR, a domain error occurs and an unspecified value is returned.
  60 .SH ERRORS
  61 .sp
  62 .LP
  63 These functions will fail if:
  64 .sp
  65 .ne 2
  66 .mk
  67 .na
  68 \fBDomain Error\fR
  69 .ad
  70 .RS 16n
  71 .rt
  72 The \fIx\fR argument is NaN or \(+-Inf, or the correct value is not
  73 representable as an integer.
  74 .sp
  75 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
  76 non-zero, then the invalid floating-point exception will be raised.
  77 .RE
  78
  79 .SH USAGE
  80 .sp
  81 .LP
  82 An application wanting to check for exceptions should call
  83 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
  84 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
  85 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
  86 raised. An application should either examine the return value or check the
  87 floating point exception flags to detect exceptions.
  88 .sp
  89 .LP
  90 These functions provide floating-to-integer conversions. They round according
  91 to the current rounding direction. If the rounded value is outside the range of
  92 the return type, the numeric result is unspecified and the invalid
  93 floating-point exception is raised. When they raise no other floating-point
  94 exception and the result differs from the argument, they raise the inexact
  95 floating-point exception.
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 tab(\a) box;
 105 cw(2.75i) |cw(2.75i)
 106 lw(2.75i) |lw(2.75i)
 107 .
 108 ATTRIBUTE TYPE\aATTRIBUTE VALUE
 109 _
 110 Interface Stability\aStandard
 111 _
 112 MT-Level\aMT-Safe
 113 .TE
 114
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBlrint\fR(3M),
 119 \fBmath.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)