std::get(std::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)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Numerics library

Common mathematical functions
Mathematical special functions (C++17)
Mathematical constants (C++20)
Basic linear algebra algorithms (C++26)
Floating-point environment (C++11)
Complex numbers
Numeric array (valarray)
Pseudo-random number generation
Factor operations
gcd (C++17)	lcm (C++17)
Interpolations
midpoint (C++20)	lerp (C++20)
Saturation arithmetic
add_sat (C++26) sub_sat (C++26) saturate_cast (C++26)	mul_sat (C++26) div_sat (C++26)
Generic numeric operations
iota (C++11) ranges::iota (C++23) accumulate inner_product adjacent_difference partial_sum	reduce (C++17) transform_reduce (C++17) inclusive_scan (C++17) exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
Bit operations
has_single_bit (C++20)     bit_cast (C++20) bit_ceil (C++20) bit_floor (C++20) bit_width (C++20) rotl (C++20) rotr (C++20)	popcount (C++20) countl_zero (C++20) countl_one (C++20) countr_zero (C++20) countr_one (C++20) byteswap (C++23) endian (C++20)

 

std::complex

Member functions
complex::complex complex::operator= complex::real complex::imag	complex::operator+=complex::operator-=complex::operator*=complex::operator/=
Non-member functions
operator+operator- operator+operator-operator*operator/ operator==operator!= (until C++20)   operator<<operator>> get(std::complex) (C++26)	real imag abs arg norm conj proj (C++11) polar operator""ioperator""ifoperator""il (C++14)(C++14)(C++14)
Exponential functions
log   log10   exp
Power functions
pow   sqrt
Trigonometric functions
sin   cos tan asin (C++11) acos (C++11) atan (C++11)
Hyperbolic functions
sinh   cosh tanh asinh (C++11) acosh (C++11) atanh (C++11)
Helper types
tuple_size<std::complex> (C++26)
tuple_element<std::complex> (C++26)

 

Defined in header <complex>
template< std::size_t I > friend constexpr T& get( std::complex<T>& x );	(1)	(since C++26)
template< std::size_t I > friend constexpr const T& get( const std::complex<T>& x );	(2)	(since C++26)
template< std::size_t I > friend constexpr T&& get( std::complex<T>&& x );	(3)	(since C++26)
template< std::size_t I > friend constexpr const T&& get( const std::complex<T>&& x );	(4)	(since C++26)

Returns the reference to real or imaginary part from a complex when I == 0 or I == 1, respectively. It is mainly provided for structured binding support.

Parameters

x

-

a complex

Return value

1-4) A reference to the real or imaginary part from the stored one when I == 0 or I == 1, respectively.

Notes

Feature-test macro	Value	Std	Feature
__cpp_lib_tuple_like	202311L	(C++26)	Add tuple protocol to std::complex

Example

Run this code

#include <complex>
 
static_assert([z = std::complex(1.0, 2.0)]
{
#if __cpp_lib_tuple_like >= 202311L
    return std::get<0>(z) == 1.0 and std::get<1>(z) == 2.0;
#else
    return z.real() == 1.0 and z.imag() == 2.0;
#endif
}());
 
int main() {}

See also

Structured binding (C++17)	binds the specified names to sub-objects or tuple elements of the initializer
get(std::tuple) (C++11)	tuple accesses specified element (function template)
get(std::pair) (C++11)	accesses an element of a pair (function template)
get(std::array) (C++11)	accesses an element of an array (function template)