original/man3/scalbln.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 SCALBLN 3 2013-06-21 "" "Linux Programmer's Manual"
  28 .SH NAME
  29 scalbn, scalbnf, scalbnl, scalbln, scalblnf, scalblnl \-
  30 multiply floating-point number by integral power of radix
  31 .SH SYNOPSIS
  32 .B #include <math.h>
  33 .sp
  34 .BI "double scalbln(double " x ", long int " exp );
  35 .br
  36 .BI "float scalblnf(float " x ", long int " exp );
  37 .br
  38 .BI "long double scalblnl(long double " x ", long int " exp );
  39 .sp
  40 .BI "double scalbn(double " x ", int " exp );
  41 .br
  42 .BI "float scalbnf(float " x ", int " exp );
  43 .br
  44 .BI "long double scalbnl(long double " x ", int " exp );
  45 .sp
  46 Link with \fI\-lm\fP.
  47 .sp
  48 .in -4n
  49 Feature Test Macro Requirements for glibc (see
  50 .BR feature_test_macros (7)):
  51 .in
  52 .sp
  53 .ad l
  54 .BR scalbln (),
  55 .BR scalblnf (),
  56 .BR scalblnl ():
  57 .RS
  58 _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  59 _POSIX_C_SOURCE\ >=\ 200112L;
  60 .br
  61 or
  62 .I cc\ -std=c99
  63 .RE
  64 .br
  65 .BR scalbn (),
  66 .BR scalbnf (),
  67 .BR scalbnl ():
  68 .RS
  69 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  70 _POSIX_C_SOURCE\ >=\ 200112L;
  71 .br
  72 or
  73 .I cc\ -std=c99
  74 .RE
  75 .ad b
  76 .SH DESCRIPTION
  77 These functions multiply their first argument
  78 .I x
  79 by
  80 .B FLT_RADIX
  81 (probably 2)
  82 to the power of
  83 .IR exp ,
  84 that is:
  85 .nf
  86
  87     x * FLT_RADIX ** exp
  88 .fi
  89
  90 The definition of
  91 .B FLT_RADIX
  92 can be obtained by including
  93 .IR <float.h> .
  94 .\" not in /usr/include but in a gcc lib
  95 .SH RETURN VALUE
  96 On success, these functions return
  97 .IR x
  98 *
  99 .B FLT_RADIX
 100 **
 101 .IR exp .
 102
 103 If
 104 .I x
 105 is a NaN, a NaN is returned.
 106
 107 If
 108 .I x
 109 is positive infinity (negative infinity),
 110 positive infinity (negative infinity) is returned.
 111
 112 If
 113 .I x
 114 is +0 (\-0), +0 (\-0) is returned.
 115
 116 If the result overflows,
 117 a range error occurs,
 118 and the functions return
 119 .BR HUGE_VAL ,
 120 .BR HUGE_VALF ,
 121 or
 122 .BR HUGE_VALL ,
 123 respectively, with a sign the same as
 124 .IR x .
 125
 126 If the result underflows,
 127 a range error occurs,
 128 and the functions return zero, with a sign the same as
 129 .IR x .
 130 .SH ERRORS
 131 See
 132 .BR math_error (7)
 133 for information on how to determine whether an error has occurred
 134 when calling these functions.
 135 .PP
 136 The following errors can occur:
 137 .TP
 138 Range error, overflow
 139 .\" .I errno
 140 .\" is set to
 141 .\" .BR ERANGE .
 142 An overflow floating-point exception
 143 .RB ( FE_OVERFLOW )
 144 is raised.
 145 .TP
 146 Range error, underflow
 147 .\" .I errno
 148 .\" is set to
 149 .\" .BR ERANGE .
 150 An underflow floating-point exception
 151 .RB ( FE_UNDERFLOW )
 152 is raised.
 153 .PP
 154 These functions do not set
 155 .IR errno .
 156 .\" FIXME . Is it intentional that these functions do not set errno?
 157 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6803
 158 .SH VERSIONS
 159 These functions first appeared in glibc in version 2.1.
 160 .SH ATTRIBUTES
 161 .SS Multithreading (see pthreads(7))
 162 The
 163 .BR scalbn (),
 164 .BR scalbnf (),
 165 .BR scalbnl (),
 166 .BR scalbln (),
 167 .BR scalblnf (),
 168 and
 169 .BR scalblnl ()
 170 functions are thread-safe.
 171 .SH CONFORMING TO
 172 C99, POSIX.1-2001.
 173 .SH NOTES
 174 These functions differ from the obsolete functions described in
 175 .BR scalb (3)
 176 in the type of their second argument.
 177 The functions described on this page have a second argument
 178 of an integral type, while those in
 179 .BR scalb (3)
 180 have a second argument of type
 181 .IR double .
 182
 183 If
 184 .B FLT_RADIX
 185 equals 2 (which is usual), then
 186 .BR scalbn ()
 187 is equivalent to
 188 .BR ldexp (3).
 189 .SH SEE ALSO
 190 .BR ldexp (3),
 191 .BR scalb (3)
 192 .SH COLOPHON
 193 This page is part of release 3.79 of the Linux
 194 .I man-pages
 195 project.
 196 A description of the project,
 197 information about reporting bugs,
 198 and the latest version of this page,
 199 can be found at
 200 \%http://www.kernel.org/doc/man\-pages/.