usr/src/man/man3m/scalbln.3m

   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 SCALBLN 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  12 .SH NAME
  13 scalbln, scalblnf, scalblnl, scalbn, scalbnf, scalbnl \- compute exponent using
  14 FLT_RADIX
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  19 #include <math.h>
  20
  21 \fBdouble\fR \fBscalbln\fR(\fBdouble\fR \fIx\fR, \fBlong\fR \fIn\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBfloat\fR \fBscalblnf\fR(\fBfloat\fR \fIx\fR, \fBlong\fR \fIn\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBlong double\fR \fBscalblnl\fR(\fBlong double\fR \fIx\fR, \fBlong\fR \fIn\fR);
  32 .fi
  33
  34 .LP
  35 .nf
  36 \fBdouble\fR \fBscalbn\fR(\fBdouble\fR \fIx\fR, \fBint\fR \fIn\fR);
  37 .fi
  38
  39 .LP
  40 .nf
  41 \fBfloat\fR \fBscalbnf\fR(\fBfloat\fR \fIx\fR, \fBint\fR \fIn\fR);
  42 .fi
  43
  44 .LP
  45 .nf
  46 \fBlong double\fR \fBscalbnl\fR(\fBlong double\fR \fIx\fR, \fBint\fR \fIn\fR);
  47 .fi
  48
  49 .SH DESCRIPTION
  50 .sp
  51 .LP
  52 These functions compute \fIx\fR * \fBFLT_RADIX\fR^n efficiently, not normally
  53 by computing \fBFLT_RADIX\fR^n explicitly.
  54 .SH RETURN VALUES
  55 .sp
  56 .LP
  57 Upon successful completion, these functions return \fIx\fR *
  58 \fBFLT_RADIX\fR^\fIn\fR>.
  59 .sp
  60 .LP
  61 If the result would cause overflow, a range error occurs and these functions
  62 return \(+-\fBHUGE_VAL\fR, \(+-\fBHUGE_VALF\fR, and \(+-\fBHUGE_VALL\fR
  63 (according to the sign of \fIx\fR) as appropriate for the return type of the
  64 function.
  65 .sp
  66 .LP
  67 If \fIx\fR is NaN, a NaN is returned.
  68 .sp
  69 .LP
  70 If \fIx\fR is \(+-0 or \(+-Inf, \fIx\fR is returned.
  71 .sp
  72 .LP
  73 If \fIx\fR is 0, \fIx\fR is returned.
  74 .SH ERRORS
  75 .sp
  76 .LP
  77 These functions will fail if:
  78 .sp
  79 .ne 2
  80 .mk
  81 .na
  82 \fBRange Error\fR
  83 .ad
  84 .RS 15n
  85 .rt
  86 The result overflows.
  87 .sp
  88 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
  89 non-zero, then the overflow floating-point exception is raised.
  90 .RE
  91
  92 .SH USAGE
  93 .sp
  94 .LP
  95 An application wanting to check for exceptions should call
  96 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
  97 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
  98 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
  99 raised. An application should either examine the return value or check the
 100 floating point exception flags to detect exceptions.
 101 .SH ATTRIBUTES
 102 .sp
 103 .LP
 104 See \fBattributes\fR(5) for descriptions of the following attributes:
 105 .sp
 106
 107 .sp
 108 .TS
 109 tab(    ) box;
 110 cw(2.75i) |cw(2.75i)
 111 lw(2.75i) |lw(2.75i)
 112 .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Standard
 116 _
 117 MT-Level        MT-Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBmath.h\fR(3HEAD),
 124 \fBscalb\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)