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

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