std::arg(std::complex)

Определено в заголовочном файле `<complex>`
template< class T > T arg( const std::complex<T>& z );	(1)
Дополнительные перегрузки (начиная с C++11)
Определено в заголовочном файле `<complex>`
float arg( float f ); double arg( double f ); long double arg( long double f );	(A)	(до C++23)
template< class FloatingPoint > FloatingPoint arg( FloatingPoint f );	(A)		(начиная с C++23)
template< class Integer > double arg( Integer i );	(B)

1) Вычисляет фазовый угол (в радианах) комплексного числа z.

A,B) Предоставляются дополнительные перегрузки для всех целочисленных типов и типов с плавающей точкой, которые рассматриваются как комплексные числа с нулевой мнимой частью.

(начиная с C++11)

Параметры

z	-	комплексное значение
f	-	значение с плавающей точкой
i	-	целочисленное значение

Возвращаемое значение

1) std::atan2(std::imag(z), std::real(z)). Если ошибок не возникает, это фазовый угол z в интервале [−π; π].

A) Ноль, если f положительно или равно +0, π, если f отрицательно или равно -0, в противном случае NaN.

B) Ноль, если i неотрицательно, π, если оно отрицательно.

Примечания

Дополнительные перегрузки не обязательно должны быть предоставлены в точности в виде (A,B). Достаточно, чтобы они обеспечивали для аргумента num следующее:

Если num имеет тип с плавающей точкой стандартного(до C++23) типа T, то std::arg(num) действует так же, как std::arg(std::complex<T>(num)).
В противном случае, если num имеет целочисленный тип, то std::arg(num) действует так же, как std::arg(std::complex<double>(num)).

Пример

#include <complex>
#include <iostream>

int main() 
{
    std::complex<double> z1(1, 0);
    std::complex<double> z2(0, 0);
    std::complex<double> z3(0, 1);
    std::complex<double> z4(-1, 0);
    std::complex<double> z5(-1, -0.0);
    double f = 1.;
    int i = -1;

    std::cout << "phase angle of " << z1 << " is " << std::arg(z1) << '\n'
              << "phase angle of " << z2 << " is " << std::arg(z2) << '\n'
              << "phase angle of " << z3 << " is " << std::arg(z3) << '\n'
              << "phase angle of " << z4 << " is " << std::arg(z4) << '\n'
              << "phase angle of " << z5 << " is " << std::arg(z5) << " "
                 "(the other side of the cut)\n"
              << "phase angle of " << f << " is " << std::arg(f) << '\n'
              << "phase angle of " << i << " is " << std::arg(i) << '\n';

}

Вывод:

phase angle of (1,0) is 0
phase angle of (0,0) is 0
phase angle of (0,1) is 1.5708
phase angle of (-1,0) is 3.14159
phase angle of (-1,-0) is -3.14159 (the other side of the cut)
phase angle of 1 is 0
phase angle of -1 is 3.14159

См. также

abs(std::complex)	возвращает модуль комплексного числа (шаблон функции)
polar	создаёт комплексное число по модулю и фазовому углу (шаблон функции)
atan2atan2fatan2l (C++11)(C++11)	арктангенс с определением квадранта по знакам аргументов (функция)
atan2(std::valarray)	применяет функцию `std::atan2` к valarray и значению (шаблон функции)
Документация C для `carg`

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/numeric/complex/arg