share/man/man3m/scalb.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 SCALB 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 scalb, scalbf, scalbl \- load exponent of a radix-independent floating-point
  50 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 \fBscalb\fR(\fBdouble\fR \fIx\fR, \fBdouble\fR \fIn\fR);
  58 .fi
  59
  60 .LP
  61 .nf
  62 \fBfloat\fR \fBscalbf\fR(\fBfloat\fR \fIx\fR, \fBfloat\fR \fIn\fR);
  63 .fi
  64
  65 .LP
  66 .nf
  67 \fBlong double\fR \fBscalbl\fR(\fBlong double\fR \fIx\fR, \fBlong double\fR \fIn\fR);
  68 .fi
  69
  70 .SH DESCRIPTION
  71 .sp
  72 .LP
  73 These functions compute x * \fIr\fR^n, where \fIr\fR is the radix of the
  74 machine's floating point arithmetic. When \fIr\fR is 2, \fBscalb()\fR is
  75 equivalent to \fBldexp\fR(3M). The value of \fIr\fR is \fBFLT_RADIX\fR which is
  76 defined in <\fBfloat.h\fR>.
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 Upon successful completion, the \fBscalb()\fR function returns \fIx\fR *
  81 \fIr\fR^n.
  82 .sp
  83 .LP
  84 If \fIx\fR or \fIn\fR is NaN, a NaN is returned.
  85 .sp
  86 .LP
  87 If \fIn\fR is 0, \fIx\fR is returned.
  88 .sp
  89 .LP
  90 If \fIx\fR is \(+-Inf and \fIn\fR is not \(miInf, \fIx\fR is returned.
  91 .sp
  92 .LP
  93 If \fIx\fR is \(+-0 and \fIn\fR is not +Inf, \fIx\fR is returned.
  94 .sp
  95 .LP
  96 If \fIx\fR is \(+-0 and \fIn\fR is +Inf, a domain error occurs and a NaN is
  97 returned.
  98 .sp
  99 .LP
 100 If \fIx\fR is \(+-Inf and \fIn\fR is \(miInf, a domain error occurs and a NaN
 101 is returned.
 102 .sp
 103 .LP
 104 If the result would cause an overflow, a range error occurs and
 105 \(+-\fBHUGE_VAL\fR (according to the sign of \fIx\fR) is returned.
 106 .sp
 107 .LP
 108 For exceptional cases, \fBmatherr\fR(3M) tabulates the values to be returned by
 109 \fBscalb()\fR as specified by SVID3 and XPG3. See \fBstandards\fR(5).
 110 .SH ERRORS
 111 .sp
 112 .LP
 113 These functions will fail if:
 114 .sp
 115 .ne 2
 116 .mk
 117 .na
 118 \fBDomain Error\fR
 119 .ad
 120 .RS 16n
 121 .rt
 122 If \fIx\fR is 0 and \fIn\fR is +Inf, or \fIx\fR is Inf and \fIn\fR is \(miInf.
 123 .sp
 124 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 125 non-zero, then the invalid floating-point exception is raised.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .mk
 131 .na
 132 \fBRange Error\fR
 133 .ad
 134 .RS 16n
 135 .rt
 136 The result would overflow.
 137 .sp
 138 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 139 non-zero, then the overflow floating-point exception is raised.
 140 .RE
 141
 142 .SH USAGE
 143 .sp
 144 .LP
 145 An application wanting to check for exceptions should call
 146 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
 147 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
 148 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
 149 raised. An application should either examine the return value or check the
 150 floating point exception flags to detect exceptions.
 151 .SH ATTRIBUTES
 152 .sp
 153 .LP
 154 See \fBattributes\fR(5) for descriptions of the following attributes:
 155 .sp
 156
 157 .sp
 158 .TS
 159 tab(    ) box;
 160 cw(2.75i) |cw(2.75i)
 161 lw(2.75i) |lw(2.75i)
 162 .
 163 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 164 _
 165 Interface Stability     See below.
 166 _
 167 MT-Level        MT-Safe
 168 .TE
 169
 170 .sp
 171 .LP
 172 The \fBscalb()\fR function is Standard. The \fBscalbf()\fR and \fBscalbl()\fR
 173 functions are Stable.
 174 .SH SEE ALSO
 175 .sp
 176 .LP
 177 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBilogb\fR(3M),
 178 \fBldexp\fR(3M), \fBlogb\fR(3M), \fBmath.h\fR(3HEAD), \fBmatherr\fR(3M),
 179 \fBscalbln\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)