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 llround 3M "12 Jul 2006" "SunOS 5.11" "Mathematical Library Functions"
  12 .SH NAME
  13 llround, llroundf, llroundl \- round to nearest integer value
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  18 #include <math.h>
  19 
  20 \fBlong long\fR \fBllround\fR(\fBdouble\fR \fIx\fR);
  21 .fi
  22 
  23 .LP
  24 .nf
  25 \fBlong long\fR \fBllroundf\fR(\fBfloat\fR \fIx\fR);
  26 .fi
  27 
  28 .LP
  29 .nf
  30 \fBlong long\fR \fBllroundl\fR(\fBlong double\fR \fIx\fR);
  31 .fi
  32 
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 These functions rounds their argument to the nearest integer value, rounding
  37 halfway cases away from 0 regardless of the current rounding direction.
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41  Upon successful completion, these functions return the rounded integer value.
  42 .sp
  43 .LP
  44 If \fIx\fR is NaN, a domain error occurs and an unspecified value is returned.
  45 .sp
  46 .LP
  47 If \fIx\fR is +Inf, a domain error occurs and an unspecified value is returned.
  48 .sp
  49 .LP
  50 If \fIx\fR is -Inf, a domain error occurs and an unspecified value is returned.
  51 .sp
  52 .LP
  53 If the correct value is positive and too large to represent as a \fBlong
  54 long\fR, a domain error occurs and an unspecified value is returned.
  55 .sp
  56 .LP
  57  If the correct value is negative and too large to represent as a \fBlong
  58 long\fR, a domain error occurs and an unspecified value is returned.
  59 .SH ERRORS
  60 .sp
  61 .LP
  62 These functions will fail if:
  63 .sp
  64 .ne 2
  65 .mk
  66 .na
  67 \fBDomain Error\fR
  68 .ad
  69 .RS 16n
  70 .rt  
  71 The \fIx\fR argument is NaN or \(+-Inf, or the correct value is not
  72 representable as an integer.
  73 .sp
  74 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
  75 non-zero, then the invalid floating-point exception will be raised.
  76 .RE
  77 
  78 .SH USAGE
  79 .sp
  80 .LP
  81 An application wanting to check for exceptions should call
  82 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
  83 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
  84 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
  85 raised. An application should either examine the return value or check the
  86 floating point exception flags to detect exceptions.
  87 .sp
  88 .LP
  89 These functions differ from the \fBllrint\fR(3M) functions in that the default
  90 rounding direction for the \fBllround()\fR functions round halfway cases away
  91 from 0 and need not raise the inexact floating-point exception for non-integer
  92 arguments that round to within the range of the return type.
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98 
  99 .sp
 100 .TS
 101 tab() box;
 102 cw(2.75i) |cw(2.75i) 
 103 lw(2.75i) |lw(2.75i) 
 104 .
 105 ATTRIBUTE TYPEATTRIBUTE VALUE
 106 _
 107 Interface StabilityStandard
 108 _
 109 MT-LevelMT-Safe
 110 .TE
 111 
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBllrint\fR(3M),
 116 \fBlrint\fR(3M), \fBlround\fR(3M), \fBmath.h\fR(3HEAD), \fBattributes\fR(5),
 117 \fBstandards\fR(5)