usr/src/man/man3m/nextafter.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) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH NEXTAFTER 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 nextafter, nextafterf, nextafterl, nexttoward, nexttowardf, nexttowardl \- next
  50 representable double-precision floating-point number
  51 .SH SYNOPSIS
  52 .LP
  53 .nf
  54 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  55 #include <math.h>
  56
  57 \fBdouble\fR \fBnextafter\fR(\fBdouble\fR \fIx\fR, \fBdouble\fR \fIy\fR);
  58 .fi
  59
  60 .LP
  61 .nf
  62 \fBfloat\fR \fBnextafterf\fR(\fBfloat\fR \fIx\fR, \fBfloat\fR \fIy\fR);
  63 .fi
  64
  65 .LP
  66 .nf
  67 \fBlong double\fR \fBnextafterl\fR(\fBlong double\fR \fIx\fR, \fBlong double\fR \fIy\fR);
  68 .fi
  69
  70 .LP
  71 .nf
  72 \fBdouble\fR \fBnexttoward\fR(\fBdouble\fR \fIx\fR, \fBlong double\fR \fIy\fR);
  73 .fi
  74
  75 .LP
  76 .nf
  77 \fBfloat\fR \fBnexttowardf\fR(\fBfloat\fR \fIx\fR, \fBlong double\fR \fIy\fR);
  78 .fi
  79
  80 .LP
  81 .nf
  82 \fBlong double\fR \fBnexttowardl\fR(\fBlong double\fR \fIx\fR, \fBlong double\fR \fIy\fR);
  83 .fi
  84
  85 .SH DESCRIPTION
  86 .sp
  87 .LP
  88 The \fBnextafter()\fR, \fBnextafterf()\fR, and \fBnextafterl()\fR functions
  89 compute the next representable floating-point value following \fIx\fR in the
  90 direction of \fIy\fR. Thus, if \fIy\fR is less than \fIx\fR, \fBnextafter()\fR
  91 returns the largest representable floating-point number less than \fIx\fR. The
  92 \fBnextafter()\fR, \fBnextafterf()\fR, and \fBnextafterl()\fR functions return
  93 \fIy\fR if \fIx\fR equals \fIy\fR.
  94 .sp
  95 .LP
  96 The \fBnexttoward()\fR, \fBnexttowardf()\fR, and \fBnexttowardl()\fR functions
  97 are equivalent to the corresponding \fBnextafter()\fR functions, except that
  98 the second parameter has type \fBlong double\fR and the functions return
  99 \fIy\fR converted to the type of the function if \fIx\fR equals \fIy\fR.
 100 .SH RETURN VALUES
 101 .sp
 102 .LP
 103 Upon successful completion, these functions return the next representable
 104 floating-point value following \fIx\fR in the direction of \fIy\fR.
 105 .sp
 106 .LP
 107 If \fIx\fR == \fIy\fR, \fIy\fR (of the type \fIx\fR) is returned.
 108 .sp
 109 .LP
 110 If \fIx\fR is finite and the correct function value would overflow, a range
 111 error occurs and \(+-\fBHUGE_VAL\fR, \(+-\fBHUGE_VALF\fR, and
 112 \(+-\fBHUGE_VALL\fR (with the same sign as \fIx\fR) is returned as appropriate
 113 for the return type of the function.
 114 .sp
 115 .LP
 116 If \fIx\fR or \fIy\fR is NaN, a NaN is returned.
 117 .sp
 118 .LP
 119 If \fIx\fR != \fIy\fR and the correct function value is subnormal, zero, or
 120 underflows, a range error occurs and either the correct function value (if
 121 representable) or 0.0 is returned.
 122 .SH ERRORS
 123 .sp
 124 .LP
 125 These functions will fail if:
 126 .sp
 127 .ne 2
 128 .mk
 129 .na
 130 \fBRange Error\fR
 131 .ad
 132 .RS 15n
 133 .rt
 134 The correct value overflows.
 135 .sp
 136 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 137 non-zero, the overflow floating-point exception is raised.
 138 .sp
 139 The \fBnextafter()\fR function sets \fBerrno\fR to \fBERANGE\fR if the correct
 140 value would overflow.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .mk
 146 .na
 147 \fBRange Error\fR
 148 .ad
 149 .RS 15n
 150 .rt
 151 The correct value underflows.
 152 .sp
 153 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 154 non-zero, the underflow floating-point exception is raised.
 155 .RE
 156
 157 .SH USAGE
 158 .sp
 159 .LP
 160 An application wanting to check for exceptions should call
 161 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
 162 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
 163 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
 164 raised. An application should either examine the return value or check the
 165 floating point exception flags to detect exceptions.
 166 .sp
 167 .LP
 168 An application can also set \fBerrno\fR to 0 before calling \fBnextafter()\fR.
 169 On return, if \fBerrno\fR is non-zero, an error has occurred. The
 170 \fBnextafterf()\fR, \fBnextafterl()\fR. \fBnexttoward()\fR,
 171 \fBnexttowardf()\fR, and \fBnexttowardl()\fR functions do not set \fBerrno\fR.
 172 .SH ATTRIBUTES
 173 .sp
 174 .LP
 175 See \fBattributes\fR(5) for descriptions of the following attributes:
 176 .sp
 177
 178 .sp
 179 .TS
 180 tab(    ) box;
 181 cw(2.75i) |cw(2.75i)
 182 lw(2.75i) |lw(2.75i)
 183 .
 184 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 185 _
 186 Interface Stability     Standard
 187 _
 188 MT-Level        MT-Safe
 189 .TE
 190
 191 .SH SEE ALSO
 192 .sp
 193 .LP
 194 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBmath.h\fR(3HEAD),
 195 \fBattributes\fR(5), \fBstandards\fR(5)