1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   4 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   5 .\" 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 
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" 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.
  10 .\" 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.
  11 .\" 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]
  12 .TH rint 3M "12 Jul 2006" "SunOS 5.11" "Mathematical Library Functions"
  13 .SH NAME
  14 rint, rintf, rintl \- round-to-nearest integral value
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  19 #include <math.h>
  20 
  21 \fBdouble\fR \fBrint\fR(\fBdouble\fR \fIx\fR);
  22 .fi
  23 
  24 .LP
  25 .nf
  26 \fBfloat\fR \fBrintf\fR(\fBfloat\fR \fIx\fR);
  27 .fi
  28 
  29 .LP
  30 .nf
  31 \fBlong double\fR \fBrintl\fR(\fBlong double\fR \fIx\fR);
  32 .fi
  33 
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 These functions return the integral value (represented as a \fBdouble\fR)
  38 nearest \fIx\fR in the direction of the current rounding mode.
  39 .sp
  40 .LP
  41 If the current rounding mode rounds toward negative infinity, \fBrint()\fR is
  42 equivalent to \fBfloor\fR(3M). If the current rounding mode rounds toward
  43 positive infinity, \fBrint()\fR is equivalent to \fBceil\fR(3M).
  44 .sp
  45 .LP
  46 These functions differ from the \fBnearbyint\fR(3M), \fBnearbyintf()\fR, and
  47 \fBnearbyintl()\fR functions only in that they might raise the inexact
  48 floating-point exception if the result differs in value from the argument.
  49 .SH RETURN VALUES
  50 .sp
  51 .LP
  52 Upon successful completion, these functions return the integer (represented as
  53 a double precision number) nearest \fIx\fR in the direction of the current
  54 rounding mode.
  55 .sp
  56 .LP
  57 If \fIx\fR is NaN, a NaN is returned.
  58 .sp
  59 .LP
  60 If \fIx\fR is \(+-0 or \(+-Inf, \fIx\fR is returned.
  61 .SH ATTRIBUTES
  62 .sp
  63 .LP
  64 See \fBattributes\fR(5) for descriptions of the following attributes:
  65 .sp
  66 
  67 .sp
  68 .TS
  69 tab() box;
  70 cw(2.75i) |cw(2.75i) 
  71 lw(2.75i) |lw(2.75i) 
  72 .
  73 ATTRIBUTE TYPEATTRIBUTE VALUE
  74 _
  75 Interface StabilityStandard
  76 _
  77 MT-LevelMT-Safe
  78 .TE
  79 
  80 .SH SEE ALSO
  81 .sp
  82 .LP
  83 \fBabs\fR(3C), \fBceil\fR(3M), \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M),
  84 \fBfloor\fR(3M), \fBisnan\fR(3M), \fBmath.h\fR(3HEAD), \fBnearbyint\fR(3M),
  85 \fBattributes\fR(5), \fBstandards\fR(5)