original/man3/scalb.3

   1 .\" Copyright 2004 Andries Brouwer <aeb@cwi.nl>.
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .TH SCALB 3 2013-03-23 "" "Linux Programmer's Manual"
  28 .SH NAME
  29 scalb, scalbf, scalbl \- multiply floating-point number
  30 by integral power of radix (OBSOLETE)
  31 .SH SYNOPSIS
  32 .B #include <math.h>
  33 .sp
  34 .BI "double scalb(double " x ", double " exp );
  35 .br
  36 .BI "float scalbf(float " x ", float " exp );
  37 .br
  38 .BI "long double scalbl(long double " x ", long double " exp );
  39 .sp
  40 Link with \fI\-lm\fP.
  41 .sp
  42 .in -4n
  43 Feature Test Macro Requirements for glibc (see
  44 .BR feature_test_macros (7)):
  45 .in
  46 .sp
  47 .ad l
  48 .BR scalb ():
  49 .RS 4
  50 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  51 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  52 .RE
  53 .br
  54 .BR scalbf (),
  55 .BR scalbl ():
  56 .RS 4
  57 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600
  58 .RE
  59 .ad b
  60 .SH DESCRIPTION
  61 These functions multiply their first argument
  62 .I x
  63 by
  64 .B FLT_RADIX
  65 (probably 2)
  66 to the power of
  67 .IR exp ,
  68 that is:
  69 .nf
  70
  71     x * FLT_RADIX ** exp
  72 .fi
  73
  74 The definition of
  75 .B FLT_RADIX
  76 can be obtained by including
  77 .IR <float.h> .
  78 .\" not in /usr/include but in a gcc lib
  79 .SH RETURN VALUE
  80 On success, these functions return \fIx\fP * \fBFLT_RADIX\fP ** \fIexp\fP.
  81
  82 If
  83 .I x
  84 or
  85 .I exp
  86 is a NaN, a NaN is returned.
  87
  88 If
  89 .I x
  90 is positive infinity (negative infinity),
  91 and
  92 .I exp
  93 is not negative infinity,
  94 positive infinity (negative infinity) is returned.
  95
  96 If
  97 .I x
  98 is +0 (\-0), and
  99 .I exp
 100 is not positive infinity, +0 (\-0) is returned.
 101
 102 If
 103 .I x
 104 is zero, and
 105 .I exp
 106 is positive infinity,
 107 a domain error occurs, and
 108 a NaN is returned.
 109
 110 If
 111 .I x
 112 is an infinity,
 113 and
 114 .I exp
 115 is negative infinity,
 116 a domain error occurs, and
 117 a NaN is returned.
 118
 119 If the result overflows,
 120 a range error occurs,
 121 and the functions return
 122 .BR HUGE_VAL ,
 123 .BR HUGE_VALF ,
 124 or
 125 .BR HUGE_VALL ,
 126 respectively, with a sign the same as
 127 .IR x .
 128
 129 If the result underflows,
 130 a range error occurs,
 131 and the functions return zero, with a sign the same as
 132 .IR x .
 133 .SH ERRORS
 134 See
 135 .BR math_error (7)
 136 for information on how to determine whether an error has occurred
 137 when calling these functions.
 138 .PP
 139 The following errors can occur:
 140 .TP
 141 Domain error: \fIx\fP is 0, and \fIexp\fP is positive infinity, \
 142 or \fIx\fP is positive infinity and \fIexp\fP is negative infinity \
 143 and the other argument is not a NaN
 144 .\" .I errno
 145 .\" is set to
 146 .\" .BR EDOM .
 147 An invalid floating-point exception
 148 .RB ( FE_INVALID )
 149 is raised.
 150 .TP
 151 Range error, overflow
 152 .\" .I errno
 153 .\" is set to
 154 .\" .BR ERANGE .
 155 An overflow floating-point exception
 156 .RB ( FE_OVERFLOW )
 157 is raised.
 158 .TP
 159 Range error, underflow
 160 .\" .I errno
 161 .\" is set to
 162 .\" .BR ERANGE .
 163 An underflow floating-point exception
 164 .RB ( FE_UNDERFLOW )
 165 is raised.
 166 .PP
 167 These functions do not set
 168 .IR errno .
 169 .\" FIXME . Is it intentional that these functions do not set errno?
 170 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6803
 171 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6804
 172 .SH CONFORMING TO
 173 .BR scalb ()
 174 is specified in POSIX.1-2001, but marked obsolescent.
 175 POSIX.1-2008 removes the specification of
 176 .BR scalb (),
 177 recommending the use of
 178 .BR scalbln (3),
 179 .BR scalblnf (3),
 180 or
 181 .BR scalblnl (3)
 182 instead.
 183 The
 184 .BR scalb ()
 185 function is from 4.3BSD.
 186
 187 .BR scalbf ()
 188 and
 189 .BR scalbl ()
 190 are unstandardized;
 191 .BR scalbf ()
 192 is nevertheless present on several other systems
 193 .\" Looking at header files: scalbf() is present on the
 194 .\" BSDs, Tru64, HP-UX 11, Irix 6.5; scalbl() is on HP-UX 11 and Tru64.
 195 .SH SEE ALSO
 196 .BR ldexp (3),
 197 .BR scalbln (3)