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 lrint 3M "12 Jul 2006" "SunOS 5.11" "Mathematical Library Functions" 12 .SH NAME 13 lrint, lrintf, lrintl \- round to nearest integer value using current rounding 14 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\fR \fBlrint\fR(\fBdouble\fR \fIx\fR); 22 .fi 23 24 .LP 25 .nf 26 \fBlong\fR \fBlrintf\fR(\fBfloat\fR \fIx\fR); 27 .fi 28 29 .LP 30 .nf 31 \fBlong\fR \fBlrintl\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 \(miInf, a domain error occurs and an unspecified value is 52 returned. 53 .sp 54 .LP 55 If the correct value is positive and too large to represent as a \fBlong\fR, a 56 domain error occurs and an unspecified value is returned. 57 .sp 58 .LP 59 If the correct value is negative and too large to represent as a \fBlong\fR, a 60 domain error occurs and an unspecified value is returned. 61 .SH ERRORS 62 .sp 63 .LP 64 These functions will fail if: 65 .sp 66 .ne 2 67 .mk 68 .na 69 \fBDomain Error\fR 70 .ad 71 .RS 16n 72 .rt 73 The \fIx\fR argument is NaN or \(+-Inf, or the correct value is not 74 representable as an integer. 75 .sp 76 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is 77 non-zero, then the invalid floating-point exception is raised. 78 .RE 79 80 .SH USAGE 81 .sp 82 .LP 83 An application wanting to check for exceptions should call 84 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On 85 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR | 86 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been 87 raised. An application should either examine the return value or check the 88 floating point exception flags to detect exceptions. 89 .SH ATTRIBUTES 90 .sp 91 .LP 92 See \fBattributes\fR(5) for descriptions of the following attributes: 93 .sp 94 95 .sp 96 .TS 97 tab() box; 98 cw(2.75i) |cw(2.75i) 99 lw(2.75i) |lw(2.75i) 100 . 101 ATTRIBUTE TYPEATTRIBUTE VALUE 102 _ 103 Interface StabilityStandard 104 _ 105 MT-LevelMT-Safe 106 .TE 107 108 .SH SEE ALSO 109 .sp 110 .LP 111 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBllrint\fR(3M), 112 \fBmath.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)