man3/ldexp.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   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 .\" References consulted:
  28 .\"     Linux libc source code
  29 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  30 .\"     386BSD man pages
  31 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  32 .\" Modified 2004-10-31 by aeb
  33 .\"
  34 .TH LDEXP 3 2021-03-22 "" "Linux Programmer's Manual"
  35 .SH NAME
  36 ldexp, ldexpf, ldexpl \- multiply floating-point number by integral power of 2
  37 .SH SYNOPSIS
  38 .nf
  39 .B #include <math.h>
  40 .PP
  41 .BI "double ldexp(double " x ", int " exp );
  42 .BI "float ldexpf(float " x ", int " exp );
  43 .BI "long double ldexpl(long double " x ", int " exp );
  44 .fi
  45 .PP
  46 Link with \fI\-lm\fP.
  47 .PP
  48 .RS -4
  49 Feature Test Macro Requirements for glibc (see
  50 .BR feature_test_macros (7)):
  51 .RE
  52 .PP
  53 .BR ldexpf (),
  54 .BR ldexpl ():
  55 .nf
  56     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  57         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  58         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  59 .fi
  60 .SH DESCRIPTION
  61 These functions return the result of multiplying the floating-point number
  62 .I x
  63 by 2 raised to the power
  64 .IR exp .
  65 .SH RETURN VALUE
  66 On success, these functions return
  67 .IR "x * (2^exp)" .
  68 .PP
  69 If
  70 .I exp
  71 is zero, then
  72 .I x
  73 is returned.
  74 .PP
  75 If
  76 .I x
  77 is a NaN,
  78 a NaN is returned.
  79 .PP
  80 If
  81 .I x
  82 is positive infinity (negative infinity),
  83 positive infinity (negative infinity) is returned.
  84 .PP
  85 If the result underflows,
  86 a range error occurs,
  87 and zero is returned.
  88 .PP
  89 If the result overflows,
  90 a range error occurs,
  91 and the functions return
  92 .BR HUGE_VAL ,
  93 .BR HUGE_VALF ,
  94 or
  95 .BR HUGE_VALL ,
  96 respectively, with a sign the same as
  97 .IR x .
  98 .SH ERRORS
  99 See
 100 .BR math_error (7)
 101 for information on how to determine whether an error has occurred
 102 when calling these functions.
 103 .PP
 104 The following errors can occur:
 105 .TP
 106 Range error, overflow
 107 .I errno
 108 is set to
 109 .BR ERANGE .
 110 An overflow floating-point exception
 111 .RB ( FE_OVERFLOW )
 112 is raised.
 113 .TP
 114 Range error, underflow
 115 .I errno
 116 is set to
 117 .BR ERANGE .
 118 An underflow floating-point exception
 119 .RB ( FE_UNDERFLOW )
 120 is raised.
 121 .SH ATTRIBUTES
 122 For an explanation of the terms used in this section, see
 123 .BR attributes (7).
 124 .ad l
 125 .nh
 126 .TS
 127 allbox;
 128 lbx lb lb
 129 l l l.
 130 Interface       Attribute       Value
 131 T{
 132 .BR ldexp (),
 133 .BR ldexpf (),
 134 .BR ldexpl ()
 135 T}      Thread safety   MT-Safe
 136 .TE
 137 .hy
 138 .ad
 139 .sp 1
 140 .SH CONFORMING TO
 141 C99, POSIX.1-2001, POSIX.1-2008.
 142 .PP
 143 The variant returning
 144 .I double
 145 also conforms to
 146 SVr4, 4.3BSD, C89.
 147 .SH SEE ALSO
 148 .BR frexp (3),
 149 .BR modf (3),
 150 .BR scalbln (3)