original/man3/log2.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 1995-08-14 by Arnt Gulbrandsen <agulbra@troll.no>
  33 .\" Modified 2002-07-27 by Walter Harms
  34 .\"     (walter.harms@informatik.uni-oldenburg.de)
  35 .\"
  36 .TH LOG2 3  2010-09-12  "" "Linux Programmer's Manual"
  37 .SH NAME
  38 log2, log2f, log2l \- base-2 logarithmic function
  39 .SH SYNOPSIS
  40 .nf
  41 .B #include <math.h>
  42 .sp
  43 .BI "double log2(double " x );
  44 .br
  45 .BI "float log2f(float " x );
  46 .br
  47 .BI "long double log2l(long double " x );
  48 .fi
  49 .sp
  50 Link with \fI\-lm\fP.
  51 .sp
  52 .in -4n
  53 Feature Test Macro Requirements for glibc (see
  54 .BR feature_test_macros (7)):
  55 .in
  56 .sp
  57 .ad l
  58 .BR log2 (),
  59 .BR log2f (),
  60 .BR log2l ():
  61 .RS 4
  62 _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L;
  63 .br
  64 or
  65 .I cc\ -std=c99
  66 .RE
  67 .ad b
  68 .SH DESCRIPTION
  69 The
  70 .BR log2 ()
  71 function returns the base 2 logarithm of
  72 .IR x .
  73 .SH RETURN VALUE
  74 On success, these functions return the base 2 logarithm of
  75 .IR x .
  76
  77 For special cases, including where
  78 .I x
  79 is 0, 1, negative, infinity, or NaN, see
  80 .BR log (3).
  81 .SH ERRORS
  82 See
  83 .BR math_error (7)
  84 for information on how to determine whether an error has occurred
  85 when calling these functions.
  86
  87 For a discussion of the errors that can occur for these functions, see
  88 .BR log (3).
  89 .SH VERSIONS
  90 These functions first appeared in glibc in version 2.1.
  91 .SH CONFORMING TO
  92 C99, POSIX.1-2001.
  93 The variant returning
  94 .I double
  95 also conforms to
  96 SVr4, 4.3BSD.
  97 .SH SEE ALSO
  98 .BR cbrt (3),
  99 .BR clog2 (3),
 100 .BR log (3),
 101 .BR log10 (3),
 102 .BR sqrt (3)
 103 .SH COLOPHON
 104 This page is part of release 3.67 of the Linux
 105 .I man-pages
 106 project.
 107 A description of the project,
 108 information about reporting bugs,
 109 and the latest version of this page,
 110 can be found at
 111 \%http://www.kernel.org/doc/man\-pages/.