SysTutorials

Linux Manual Pages › Section 3

stdlogstdcomplex(3)

std::log(std::complex) - std::log(std::complex)

Synopsis

Defined in header<complex>
    template <class T>
    complex<T> log(const complex<T> &z);

Computes complex natural (base e) logarithm of a complex value z with a branch cut along the negative real axis.

Parameters

z - complex value

Return value

If no errors occur, the complex natural logarithm of z is returned, in the range of a strip in the interval [−iπ, +iπ] along the imaginary axis and mathematically unbounded along the real axis. Error handling and special values Errors are reported consistent with math_errhandling If the implementation supports IEEE floating-point arithmetic,

Notes

The natural logarithm of a complex number z with polar coordinate components (r,θ) equals ln r + i(θ+2nπ), with the principal value ln r + iθ The semantics of this function are intended to be consistent with the C function clog. Defect reports The following behavior-changing defect reports were applied retroactively to previously published C++ standards. DR Applied to Behavior as published Correct behavior LWG_2597 C++98 specification mishandles signed zero imaginary parts erroneous requirement removed

Example

// Run this code

#include <iostream>
#include <cmath>
#include <complex>
int main()
{
std::complex<double> z(0, 1); // // r = 1, θ = pi/2
std::cout << "2log" << z << " = " << 2. * std::log(z) << ‘\n’;
std::complex<double> z2(sqrt(2) / 2, sqrt(2) / 2); // r = 1, θ = pi/4
std::cout << "4log" << z2 << " = " << 4. * std::log(z2) << ‘\n’;
std::complex<double> z3(-1, 0); // r = 1, θ = pi
std::cout << "log" << z3 << " = " << std::log(z3) << ‘\n’;
std::complex<double> z4(-1, -0.0); // the other side of the cut
std::cout << "log" << z4 << " (the other side of the cut) = " << std::log(z4) << ‘\n’;
}

Output:

  2log(0,1) = (0,3.14159)   4log(0.707107,0.707107) = (0,3.14159)   log(-1,0) = (0,3.14159)   log(-1,-0) (the other side of the cut) = (0,-3.14159)

See also

                    complex common logarithm with the branch cuts along the negative real axis log10(std::complex) (function template)                     complex base e exponential exp(std::complex) (function template) log logf logl computes natural (base e) logarithm (ln(x))                     (function) (C++11) (C++11)                     applies the function std::log to each element of valarray log(std::valarray) (function template)