usr/src/man/man3m/exp2.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 EXP2 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  47 .SH NAME
  48 exp2, exp2f, exp2l \- exponential base 2 functions
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  53 #include <math.h>
  54
  55 \fBdouble\fR \fBexp2\fR(\fBdouble\fR \fIx\fR);
  56 .fi
  57
  58 .LP
  59 .nf
  60 \fBfloat\fR \fBexp2f\fR(\fBfloat\fR \fIx\fR);
  61 .fi
  62
  63 .LP
  64 .nf
  65 \fBlong double\fR \fBexp2l\fR(\fBlong double\fR \fIx\fR);
  66 .fi
  67
  68 .SH DESCRIPTION
  69 .sp
  70 .LP
  71 These functions compute the base-2 exponential of \fIx\fR.
  72 .SH RETURN VALUES
  73 .sp
  74 .LP
  75 Upon successful completion, these functions return 2^\fIx\fR.
  76 .sp
  77 .LP
  78 If the correct value would cause overflow, a range error occurs and
  79 \fBexp2()\fR, \fBexp2f()\fR, and \fBexp2l()\fR return the value of the macro
  80 \fBHUGE_VAL\fR, \fBHUGE_VALF\fR, and \fBHUGE_VALL\fR, respectively.
  81 .sp
  82 .LP
  83 If \fIx\fR is NaN, a NaN is returned.
  84 .sp
  85 .LP
  86 If \fIx\fR is \(+-0, 1 is returned.
  87 .sp
  88 .LP
  89 If \fIx\fR is \(miInf, +0 is returned.
  90 .sp
  91 .LP
  92 If \fIx\fR is +Inf, \fIx\fR is returned.
  93 .SH ERRORS
  94 .sp
  95 .LP
  96 These functions will fail if:
  97 .sp
  98 .ne 2
  99 .mk
 100 .na
 101 \fBRange Error\fR
 102 .ad
 103 .RS 15n
 104 .rt
 105 The result overflows.
 106 .sp
 107 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 108 non-zero, the overflow floating-point exception will be raised.
 109 .RE
 110
 111 .SH USAGE
 112 .sp
 113 .LP
 114 An application wanting to check for exceptions should call
 115 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
 116 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
 117 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
 118 raised. An application should either examine the return value or check the
 119 floating point exception flags to detect exceptions.
 120 .SH ATTRIBUTES
 121 .sp
 122 .LP
 123 See \fBattributes\fR(5) for descriptions of the following attributes:
 124 .sp
 125
 126 .sp
 127 .TS
 128 tab(    ) box;
 129 cw(2.75i) |cw(2.75i)
 130 lw(2.75i) |lw(2.75i)
 131 .
 132 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 133 _
 134 Interface Stability     Standard
 135 _
 136 MT-Level        MT-Safe
 137 .TE
 138
 139 .SH SEE ALSO
 140 .sp
 141 .LP
 142 \fBexp\fR(3M), \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M),
 143 \fBisnan\fR(3M), \fBlog\fR(3M), \fBmath.h\fR(3HEAD), \fBattributes\fR(5),
 144 \fBstandards\fR(5)