Standard library header <complex>

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros(C++20)

Language support library

Concepts library(C++20)

Diagnostics library

Memory management library

Metaprogramming library(C++11)

General utilities library

Containers library

Iterators library

Ranges library(C++20)

Algorithms library

Strings library

Text processing library

Numerics library

Date and time library

Input/output library

Filesystem library(C++17)

Concurrency support library(C++11)

Execution control library(C++26)

Technical specifications

Symbols index

External libraries

 

Standard library headers

Language support <cfloat> <climits> <compare>(C++20) <contracts>(C++26) <coroutine>(C++20) <csetjmp> <csignal> <cstdarg> <cstddef> <cstdint>(C++11) <cstdlib> <exception> <initializer_list>(C++11)    <limits> <new> <source_location>(C++20) <stdfloat>(C++23) <typeinfo> <version>(C++20) Concepts <concepts>(C++20) Diagnostics <cassert> <cerrno> <debugging>(C++26) <stacktrace>(C++23) <stdexcept> <system_error>(C++11) Memory management <memory> <memory_resource>(C++17) <scoped_allocator>(C++11) Metaprogramming <type_traits>(C++11) <ratio>(C++11)

General utilities <any>(C++17) <bitset> <bit>(C++20) <charconv>(C++17) <expected>(C++23) <format>(C++20) <functional> <optional>(C++17) <stdbit.h>(C++26) <tuple>(C++11) <typeindex>(C++11) <utility> <variant>(C++17) Containers <array>(C++11) <deque> <flat_map>(C++23) <flat_set>(C++23) <forward_list>(C++11) <hive>(C++26) <inplace_vector>(C++26)    <list> <map> <mdspan>(C++23) <queue> <set> <span>(C++20) <stack> <unordered_map>(C++11) <unordered_set>(C++11) <vector> Iterators <iterator> Ranges <generator>(C++23) <ranges>(C++20)

Algorithms <algorithm> <numeric> Strings <cctype> <cstring> <cuchar>(C++11) <cwchar> <cwctype> <string_view>(C++17) <string> Text processing <clocale> <codecvt>(C++11/17/26*) <locale> <regex>(C++11) <text_encoding>(C++26)    Numerics <cfenv>(C++11) <cmath> <complex> <linalg>(C++26) <numbers>(C++20) <random>(C++11) <simd>(C++26) <stdckdint.h>(C++26) <valarray> Time <chrono>(C++11) <ctime> C compatibility <ccomplex>(C++11/17/20*) <ciso646>(until C++20) <cstdalign>(C++11/17/20*) <cstdbool>(C++11/17/20*) <ctgmath>(C++11/17/20*)

Input/output <cinttypes>(C++11) <cstdio> <filesystem>(C++17) <fstream> <iomanip> <iosfwd> <iostream> <ios> <istream> <ostream> <print>(C++23) <spanstream>(C++23) <sstream> <streambuf> <strstream>(C++98/26*) <syncstream>(C++20) Concurrency support <atomic>(C++11) <barrier>(C++20) <condition_variable>(C++11) <future>(C++11) <hazard_pointer>(C++26) <latch>(C++20) <mutex>(C++11) <rcu>(C++26) <semaphore>(C++20) <shared_mutex>(C++14) <stdatomic.h>(C++23) <stop_token>(C++20) <thread>(C++11) Execution support <execution>(C++17)

 

This header is part of the numeric library.

Classes

complex

a complex number type (class template)

Functions

Operations
operator+operator-	applies unary operators to complex numbers (function template)
operator+operator-operator*operator/	performs complex number arithmetic on two complex values or a complex and a scalar (function template)
operator==operator!= (removed in C++20)	compares two complex numbers or a complex and a scalar (function template)
operator<<operator>>	serializes and deserializes a complex number (function template)
real	returns the real part (function template)
imag	returns the imaginary part (function template)
abs(std::complex)	returns the magnitude of a complex number (function template)
arg	returns the phase angle (function template)
norm	returns the squared magnitude (function template)
conj	returns the complex conjugate (function template)
proj (C++11)	returns the projection onto the Riemann sphere (function template)
polar	constructs a complex number from magnitude and phase angle (function template)
Exponential functions
exp(std::complex)	complex base e exponential (function template)
log(std::complex)	complex natural logarithm with the branch cuts along the negative real axis (function template)
log10(std::complex)	complex common logarithm with the branch cuts along the negative real axis (function template)
Power functions
pow(std::complex)	complex power, one or both arguments may be a complex number (function template)
sqrt(std::complex)	complex square root in the range of the right half-plane (function template)
Trigonometric functions
sin(std::complex)	computes sine of a complex number (\({\small\sin{z}}\)sin(z)) (function template)
cos(std::complex)	computes cosine of a complex number (\({\small\cos{z}}\)cos(z)) (function template)
tan(std::complex)	computes tangent of a complex number (\({\small\tan{z}}\)tan(z)) (function template)
asin(std::complex) (C++11)	computes arc sine of a complex number (\({\small\arcsin{z}}\)arcsin(z)) (function template)
acos(std::complex) (C++11)	computes arc cosine of a complex number (\({\small\arccos{z}}\)arccos(z)) (function template)
atan(std::complex) (C++11)	computes arc tangent of a complex number (\({\small\arctan{z}}\)arctan(z)) (function template)
Hyperbolic functions
sinh(std::complex)	computes hyperbolic sine of a complex number (\({\small\sinh{z}}\)sinh(z)) (function template)
cosh(std::complex)	computes hyperbolic cosine of a complex number (\({\small\cosh{z}}\)cosh(z)) (function template)
tanh(std::complex)	computes hyperbolic tangent of a complex number (\({\small\tanh{z}}\)tanh(z)) (function template)
asinh(std::complex) (C++11)	computes area hyperbolic sine of a complex number (\({\small\operatorname{arsinh}{z}}\)arsinh(z)) (function template)
acosh(std::complex) (C++11)	computes area hyperbolic cosine of a complex number (\({\small\operatorname{arcosh}{z}}\)arcosh(z)) (function template)
atanh(std::complex) (C++11)	computes area hyperbolic tangent of a complex number (\({\small\operatorname{artanh}{z}}\)artanh(z)) (function template)
Literals
operator""ifoperator""ioperator""il (C++14)	a std::complex literal representing purely imaginary number (function)

Synopsis

namespace std {template<class T>class complex;   template<>class complex<float>;template<>class complex<double>;template<>class complex<longdouble>;   // operators:template<class T>constexpr complex<T> operator+(const complex<T>&, const complex<T>&);template<class T>constexpr complex<T> operator+(const complex<T>&, const T&);template<class T>constexpr complex<T> operator+(const T&, const complex<T>&);   template<class T>constexpr complex<T> operator-(const complex<T>&, const complex<T>&);template<class T>constexpr complex<T> operator-(const complex<T>&, const T&);template<class T>constexpr complex<T> operator-(const T&, const complex<T>&);   template<class T>constexpr complex<T> operator*(const complex<T>&, const complex<T>&);template<class T>constexpr complex<T> operator*(const complex<T>&, const T&);template<class T>constexpr complex<T> operator*(const T&, const complex<T>&);   template<class T>constexpr complex<T> operator/(const complex<T>&, const complex<T>&);template<class T>constexpr complex<T> operator/(const complex<T>&, const T&);template<class T>constexpr complex<T> operator/(const T&, const complex<T>&);   template<class T>constexpr complex<T> operator+(const complex<T>&);template<class T>constexpr complex<T> operator-(const complex<T>&);   template<class T>constexprbool operator==(const complex<T>&, const complex<T>&);template<class T>constexprbool operator==(const complex<T>&, const T&);template<class T>constexprbool operator==(const T&, const complex<T>&);   template<class T>constexprbool operator!=(const complex<T>&, const complex<T>&);template<class T>constexprbool operator!=(const complex<T>&, const T&);template<class T>constexprbool operator!=(const T&, const complex<T>&);   template<class T, class CharT, class Traits> basic_istream<CharT, Traits>& operator>>(basic_istream<CharT, Traits>&, complex<T>&);   template<class T, class CharT, class Traits> basic_ostream<CharT, Traits>& operator<<(basic_ostream<CharT, Traits>&, const complex<T>&);   // values:template<class T>constexpr T real(const complex<T>&);template<class T>constexpr T imag(const complex<T>&);   template<class T> T abs(const complex<T>&);template<class T> T arg(const complex<T>&);template<class T>constexpr T norm(const complex<T>&);   template<class T>constexpr complex<T> conj(const complex<T>&);template<class T> complex<T> proj(const complex<T>&);template<class T> complex<T> polar(const T&, const T&=0);   // transcendentals:template<class T> complex<T> acos(const complex<T>&);template<class T> complex<T> asin(const complex<T>&);template<class T> complex<T> atan(const complex<T>&);   template<class T> complex<T> acosh(const complex<T>&);template<class T> complex<T> asinh(const complex<T>&);template<class T> complex<T> atanh(const complex<T>&);   template<class T> complex<T> cos (const complex<T>&);template<class T> complex<T> cosh (const complex<T>&);template<class T> complex<T> exp (const complex<T>&);template<class T> complex<T> log (const complex<T>&);template<class T> complex<T> log10(const complex<T>&);   template<class T> complex<T> pow(const complex<T>&, const T&);template<class T> complex<T> pow(const complex<T>&, const complex<T>&);template<class T> complex<T> pow(const T&, const complex<T>&);   template<class T> complex<T> sin (const complex<T>&);template<class T> complex<T> sinh(const complex<T>&);template<class T> complex<T> sqrt(const complex<T>&);template<class T> complex<T> tan (const complex<T>&);template<class T> complex<T> tanh(const complex<T>&);   // tuple interface:template<class T>struct tuple_size;template<size_t I, class T>struct tuple_element;template<class T>struct tuple_size<complex<T>>;template<size_t I, class T>struct tuple_element<I, complex<T>>;template<size_t I, class T>constexpr T& get(complex<T>&)noexcept;template<size_t I, class T>constexpr T&& get(complex<T>&&)noexcept;template<size_t I, class T>constexprconst T& get(const complex<T>&)noexcept;template<size_t I, class T>constexprconst T&& get(const complex<T>&&)noexcept;   // complex literals:inlinenamespace literals {inlinenamespace complex_literals {constexpr complex<longdouble> operator""il(longdouble);constexpr complex<longdouble> operator""il(unsignedlonglong);constexpr complex<double> operator""i(longdouble);constexpr complex<double> operator""i(unsignedlonglong);constexpr complex<float> operator""if(longdouble);constexpr complex<float> operator""if(unsignedlonglong);}}}

Class std::complex

template<class T>class complex {public:typedef T value_type;constexpr complex(const T& re = T(), const T& im = T());constexpr complex(const complex&)=default;template<class X>constexprexplicit(/* see constructor page */) complex(const complex<X>&);   constexpr T real()const;constexprvoid real(T);constexpr T imag()const;constexprvoid imag(T);   constexpr complex<T>& operator=(const T&);constexpr complex<T>& operator+=(const T&);constexpr complex<T>& operator-=(const T&);constexpr complex<T>& operator*=(const T&);constexpr complex<T>& operator/=(const T&);   constexpr complex& operator=(const complex&);template<class X>constexpr complex<T>& operator=(const complex<X>&);template<class X>constexpr complex<T>& operator+=(const complex<X>&);template<class X>constexpr complex<T>& operator-=(const complex<X>&);template<class X>constexpr complex<T>& operator*=(const complex<X>&);template<class X>constexpr complex<T>& operator/=(const complex<X>&);};

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 79	C++98	the default argument of the second parameter of polar was missing in the synopsis	added