original/man3/log.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 LOG 3  2010-09-20  "" "Linux Programmer's Manual"
  37 .SH NAME
  38 log, logf, logl \- natural logarithmic function
  39 .SH SYNOPSIS
  40 .nf
  41 .B #include <math.h>
  42 .sp
  43 .BI "double log(double " x );
  44 .br
  45 .BI "float logf(float " x );
  46 .br
  47 .BI "long double logl(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 logf (),
  59 .BR logl ():
  60 .RS 4
  61 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  62 _POSIX_C_SOURCE\ >=\ 200112L;
  63 .br
  64 or
  65 .I cc\ -std=c99
  66 .RE
  67 .ad
  68 .SH DESCRIPTION
  69 The
  70 .BR log ()
  71 function returns the natural logarithm of
  72 .IR x .
  73 .SH RETURN VALUE
  74 On success, these functions return the natural logarithm of
  75 .IR x .
  76
  77 If
  78 .I x
  79 is a NaN,
  80 a NaN is returned.
  81
  82 If
  83 .I x
  84 is 1, the result is +0.
  85
  86 If
  87 .I x
  88 is positive infinity,
  89 positive infinity is returned.
  90
  91 If
  92 .I x
  93 is zero,
  94 then a pole error occurs, and the functions return
  95 .RB - HUGE_VAL ,
  96 .RB - HUGE_VALF ,
  97 or
  98 .RB - HUGE_VALL ,
  99 respectively.
 100
 101 If
 102 .I x
 103 is negative (including negative infinity), then
 104 a domain error occurs, and a NaN (not a number) is returned.
 105 .SH ERRORS
 106 See
 107 .BR math_error (7)
 108 for information on how to determine whether an error has occurred
 109 when calling these functions.
 110 .PP
 111 The following errors can occur:
 112 .TP
 113 Domain error: \fIx\fP is negative
 114 .I errno
 115 is set to
 116 .BR EDOM .
 117 An invalid floating-point exception
 118 .RB ( FE_INVALID )
 119 is raised.
 120 .TP
 121 Pole error: \fIx\fP is zero
 122 .I errno
 123 is set to
 124 .BR ERANGE .
 125 A divide-by-zero floating-point exception
 126 .RB ( FE_DIVBYZERO )
 127 is raised.
 128 .SH CONFORMING TO
 129 C99, POSIX.1-2001.
 130 The variant returning
 131 .I double
 132 also conforms to
 133 SVr4, 4.3BSD, C89.
 134 .SH BUGS
 135 In glibc 2.5 and earlier,
 136 taking the
 137 .BR log ()
 138 of a NaN produces a bogus invalid floating-point
 139 .RB ( FE_INVALID )
 140 exception.
 141 .SH SEE ALSO
 142 .BR cbrt (3),
 143 .BR clog (3),
 144 .BR log10 (3),
 145 .BR log1p (3),
 146 .BR log2 (3),
 147 .BR sqrt (3)
 148 .SH COLOPHON
 149 This page is part of release 3.79 of the Linux
 150 .I man-pages
 151 project.
 152 A description of the project,
 153 information about reporting bugs,
 154 and the latest version of this page,
 155 can be found at
 156 \%http://www.kernel.org/doc/man\-pages/.