std::log

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Technical Specifications

 

Numerics library

Common mathematical functions

Floating-point environment

Complex numbers

Numeric arrays

Pseudo-random number generation

Compile-time rational arithmetic (C++11)

Generic numeric operations

iota (C++11)

accumulate

inner_product

adjacent_difference

partial_sum

 

Common mathematical functions

Functions
Basic operations
abs(int)labsllabsimaxabs (C++11) abs(float)fabs divldivlldivimaxdiv (C++11) fmod	remainder (C++11) remquo (C++11) fma (C++11) fmax (C++11) fmin (C++11) fdim (C++11) nannanfnanl (C++11)(C++11)(C++11)
Exponential functions
exp exp2 (C++11) expm1 (C++11)	log log10 log1p (C++11) log2 (C++11)
Power functions
sqrt cbrt (C++11)	hypot (C++11) pow
Trigonometric and hyperbolic functions
sin cos tan asin acos atan atan2	sinh cosh tanh asinh (C++11) acosh (C++11) atanh (C++11)

Error and gamma functions
erf (C++11) erfc (C++11)	lgamma (C++11) tgamma (C++11)
Nearest integer floating point operations
ceil floor roundlroundllround (C++11)(C++11)(C++11)	trunc (C++11) nearbyint (C++11) rintlrintllrint (C++11)(C++11)(C++11)
Floating point manipulation functions
ldexp scalbnscalbln (C++11)(C++11) ilogb (C++11) logb (C++11)	frexp modf nextafternexttoward (C++11)(C++11) copysign (C++11)
Classification/Comparison
fpclassify (C++11) isfinite (C++11) isinf (C++11) isnan (C++11) isnormal (C++11) signbit (C++11)	isgreater (C++11) isgreaterequal (C++11) isless (C++11) islessequal (C++11) islessgreater (C++11) isunordered (C++11)
Macro constants
HUGE_VALFHUGE_VALHUGE_VALL (C++11)(C++11) INFINITY (C++11) NAN (C++11) math_errhandlingMATH_ERRNOMATH_ERREXCEPT (C++11)	FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN (C++11)(C++11)(C++11)(C++11)(C++11)

 

Defined in header <cmath>
float       log( float arg );	(1)
double      log( double arg );	(2)
long double log( long double arg );	(3)
double      log( Integral arg );	(4)	(since C++11)

1-3) Computes the the natural (base e) logarithm of arg.

4) A set of overloads or a function template accepting an argument of any integral type. Equivalent to 2) (the argument is cast to double).

Parameters

arg

-

value of floating-point or Integral type

Return value

If no errors occur, the natural (base-e) logarithm of arg (ln(arg) or log
e(arg)) is returned.

If a domain error occurs, an implementation-defined value is returned (NaN where supported)

If a pole error occurs, -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL is returned.

Error handling

Errors are reported as specified in math_errhandling

Domain error occurs if arg is less than zero.

Pole error may occur if arg is zero.

If the implementation supports IEEE floating-point arithmetic (IEC 60559),

• If the argument is ±0, -∞ is returned and FE_DIVBYZERO is raised.
• If the argument is 1, +0 is returned
• If the argument is negative, NaN is returned and FE_INVALID is raised.
• If the argument is +∞, +∞ is returned
• If the argument is NaN, NaN is returned

Example

Run this code

#include <iostream>
#include <cmath>
#include <cerrno>
#include <cstring>
#include <cfenv>
#pragma STDC FENV_ACCESS ON
int main()
{
    std::cout << "log(1) = " << std::log(1) << '\n'
              << "base-5 logarithm of 125 = " << std::log(125)/std::log(5) << '\n';
    // special values
    std::cout << "log(1) = " << std::log(1) << '\n'
              << "log(+Inf) = " << std::log(INFINITY) << '\n';
    // error handling 
    errno=0; std::feclearexcept(FE_ALL_EXCEPT);
    std::cout << "log(0) = " << std::log(0) << '\n';
    if(errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if(std::fetestexcept(FE_DIVBYZERO))
        std::cout << "    FE_DIVBYZERO raised\n";
}

Possible output:

log(1) = 0
base-5 logarithm of 125 = 3
log(1) = 0
log(+Inf) = inf
log(0) = -inf
    errno == ERANGE: Numerical result out of range
    FE_DIVBYZERO raised

See also

log10	computes common (base 10) logarithm (log10(x)) (function)
log2 (C++11)	base 2 logarithm of the given number (log2(x)) (function)
log1p (C++11)	natural logarithm (to base e) of 1 plus the given number (ln(1+x)) (function)
exp	returns e raised to the given power (ex) (function)
log(std::complex)	complex natural logarithm with the branch cuts along the negative real axis (function template)
log(std::valarray)	applies the function std::log to each element of valarray (function template)
C documentation for log