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 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified 1995-08-14 by Arnt Gulbrandsen <agulbra@troll.no>
  31 .\" Modified 2002-07-27 by Walter Harms
  32 .\"     (walter.harms@informatik.uni-oldenburg.de)
  33 .\"
  34 .TH LOG 3  2010-09-20  "" "Linux Programmer's Manual"
  35 .SH NAME
  36 log, logf, logl \- natural logarithmic function
  37 .SH SYNOPSIS
  38 .nf
  39 .B #include <math.h>
  40 .sp
  41 .BI "double log(double " x );
  42 .br
  43 .BI "float logf(float " x );
  44 .br
  45 .BI "long double logl(long double " x );
  46 .fi
  47 .sp
  48 Link with \fI\-lm\fP.
  49 .sp
  50 .in -4n
  51 Feature Test Macro Requirements for glibc (see
  52 .BR feature_test_macros (7)):
  53 .in
  54 .sp
  55 .ad l
  56 .BR logf (),
  57 .BR logl ():
  58 .RS 4
  59 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  60 _POSIX_C_SOURCE\ >=\ 200112L;
  61 .br
  62 or
  63 .I cc\ -std=c99
  64 .RE
  65 .ad
  66 .SH DESCRIPTION
  67 The
  68 .BR log ()
  69 function returns the natural logarithm of \fIx\fP.
  70 .SH RETURN VALUE
  71 On success, these functions return the natural logarithm of
  72 .IR x .
  73
  74 If
  75 .I x
  76 is a NaN,
  77 a NaN is returned.
  78
  79 If
  80 .I x
  81 is 1, the result is +0.
  82
  83 If
  84 .I x
  85 is positive infinity,
  86 positive infinity is returned.
  87
  88 If
  89 .I x
  90 is zero,
  91 then a pole error occurs, and the functions return
  92 .RB - HUGE_VAL ,
  93 .RB - HUGE_VALF ,
  94 or
  95 .RB - HUGE_VALL ,
  96 respectively.
  97
  98 If
  99 .I x
 100 is negative (including negative infinity), then
 101 a domain error occurs, and a NaN (not a number) is returned.
 102 .SH ERRORS
 103 See
 104 .BR math_error (7)
 105 for information on how to determine whether an error has occurred
 106 when calling these functions.
 107 .PP
 108 The following errors can occur:
 109 .TP
 110 Domain error: \fIx\fP is negative
 111 .I errno
 112 is set to
 113 .BR EDOM .
 114 An invalid floating-point exception
 115 .RB ( FE_INVALID )
 116 is raised.
 117 .TP
 118 Pole error: \fIx\fP is zero
 119 .I errno
 120 is set to
 121 .BR ERANGE .
 122 A divide-by-zero floating-point exception
 123 .RB ( FE_DIVBYZERO )
 124 is raised.
 125 .SH "CONFORMING TO"
 126 C99, POSIX.1-2001.
 127 The variant returning
 128 .I double
 129 also conforms to
 130 SVr4, 4.3BSD, C89.
 131 .SH BUGS
 132 In glibc 2.5 and earlier,
 133 taking the
 134 .BR log ()
 135 of a NaN produces a bogus invalid floating-point
 136 .RB ( FE_INVALID )
 137 exception.
 138 .SH "SEE ALSO"
 139 .BR cbrt (3),
 140 .BR clog (3),
 141 .BR log10 (3),
 142 .BR log1p (3),
 143 .BR log2 (3),
 144 .BR sqrt (3)