lib/libc/gen/ldexp.3

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)ldexp.3     8.2 (Berkeley) 4/19/94
  33 .\" $FreeBSD: src/lib/libc/gen/ldexp.3,v 1.5.2.3 2001/12/14 18:33:51 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/ldexp.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd April 19, 1994
  37 .Dt LDEXP 3
  38 .Os
  39 .Sh NAME
  40 .Nm ldexp
  41 .Nd multiply floating-point number by integral power of 2
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In math.h
  46 .Ft double
  47 .Fn ldexp "double x" "int exp"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn ldexp
  51 function multiplies a floating-point number by an integral
  52 power of 2.
  53 .Sh RETURN VALUES
  54 The
  55 .Fn ldexp
  56 function returns the value of
  57 .Fa x
  58 times 2 raised to the power
  59 .Fa exp .
  60 .Pp
  61 If the resultant value would cause an overflow,
  62 the global variable
  63 .Va errno
  64 is set to
  65 .Er ERANGE
  66 and the value
  67 .Dv HUGE
  68 is returned.
  69 .Sh SEE ALSO
  70 .Xr frexp 3 ,
  71 .Xr math 3 ,
  72 .Xr modf 3
  73 .Sh STANDARDS
  74 The
  75 .Fn ldexp
  76 function conforms to
  77 .St -isoC .