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