Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/numeric/complex/imag2"

From cppreference.com
< cpp‎ | numeric‎ | complex
(c++14 constexpr, revbox)
m (Minor fix.)
 
(8 intermediate revisions by 6 users not shown)
Line 2: Line 2:
 
{{cpp/numeric/complex/navbar}}
 
{{cpp/numeric/complex/navbar}}
 
{{dcl begin}}
 
{{dcl begin}}
−
{{dcl header | complex}}
+
{{dcl header|complex}}
−
{{dcl rev begin}}
+
{{dcl rev multi|num=1|dcl1=
−
{{dcl | num=1 | until=c++14 | 1=
+
 
template< class T >  
 
template< class T >  
−
T imag( const complex<T>& z );
+
T imag( const std::complex<T>& z );
−
}}
+
|since2=c++14|dcl2=
−
{{dcl | num=1 | since=c++14 | 1=
+
 
template< class T >  
 
template< class T >  
−
constexpr T imag( const complex<T>& z );
+
constexpr T imag( const std::complex<T>& z );
 
}}
 
}}
−
{{dcl rev end}}
+
{{dcl h|[[#Notes|Additional overloads]] {{mark since c++11}}}}
−
{{dcl | num=2 | since=c++11 | 1=
+
{{dcl header|complex}}
−
long double imag( long double z );
+
{{dcl rev multi|num=A|dcl1=
 +
float      imag( float f );
 +
double      imag( double f );
 +
long double imag( long double f );
 +
|since2=c++14|dcl2=
 +
constexpr float      imag( float f );
 +
constexpr double      imag( double f );
 +
constexpr long double imag( long double f );
 +
|since3=c++23|dcl3=
 +
template< class FloatingPoint >
 +
FloatingPoint imag( FloatingPoint f );
 
}}
 
}}
−
{{dcl | num=3 | since=c++11 | 1=
+
{{dcl rev multi|num=B|dcl1=
−
template< class DoubleOrIngeter >
+
template< class Integer >  
−
double imag( DoubleOrInteger z );
+
double imag( Integer i );
−
}}
+
|since2=c++14|dcl2=
−
{{dcl | num=4 | since=c++11 | 1=
+
template< class Integer >
−
float imag( float z );
+
constexpr double imag( Integer i );
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
  
−
Returns the imaginary component of the complex number {{tt|z}}, i.e. {{c|z.imag()}}.
+
@1@ Returns the imaginary part of the complex number {{c|z}}, i.e. {{c|z.imag()}}.
  
−
{{rev inl|since=c++11|Additional overloads are provided for {{c|float}}, {{c|double}}, {{c|long double}}, and all integer types, which are treated as complex numbers with zero imaginary component.}}
+
{{rrev|since=c++11|
 +
@A,B@ Additional overloads are provided for all integer and floating-point types, which are treated as complex numbers with zero imaginary part.
 +
}}
  
 
===Parameters===
 
===Parameters===
 
{{par begin}}
 
{{par begin}}
−
{{par | z | complex value}}
+
{{par|z|complex value}}
 +
{{par|f|floating-point value}}
 +
{{par|i|integer value}}
 
{{par end}}
 
{{par end}}
  
 
===Return value===
 
===Return value===
 +
@1@ The imaginary part of {{c|z}}.
 +
@A@ {{c|decltype(f){}<!---->}} (zero).
 +
@B@ {{c|0.0}}.
  
−
the imaginary component of {{tt|z}}
+
===Notes===
 +
{{cpp/numeric/complex/additional overload note|imag}}
  
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc inc | cpp/numeric/complex/dsc real}}
+
{{dsc inc|cpp/numeric/complex/dsc imag}}
−
{{dsc inc | cpp/numeric/complex/dsc imag}}
+
{{dsc inc|cpp/numeric/complex/dsc real2}}
−
{{dsc inc | cpp/numeric/complex/dsc imag2}}
+
{{dsc see c|c/numeric/complex/cimag}}
 
{{dsc end}}
 
{{dsc end}}
  
−
[[de:cpp/numeric/complex/imag2]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
−
[[es:cpp/numeric/complex/imag2]]
+
−
[[fr:cpp/numeric/complex/imag2]]
+
−
[[it:cpp/numeric/complex/imag2]]
+
−
[[ja:cpp/numeric/complex/imag2]]
+
−
[[pt:cpp/numeric/complex/imag2]]
+
−
[[ru:cpp/numeric/complex/imag2]]
+
−
[[zh:cpp/numeric/complex/imag2]]
+

Latest revision as of 17:53, 12 March 2023

 
C++
 
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
(C++17)
(C++17)
Interpolations
(C++20)
(C++20)
Saturation arithmetic
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)

Generic numeric operations
Bit operations
(C++20)    
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++23)
(C++20)
 
std::complex
 
Defined in header <complex>
(1)
template< class T >
T imag( const std::complex<T>& z );
 (until C++14)
template< class T >
constexpr T imag( const std::complex<T>& z );
 (since C++14)
Additional overloads (since C++11)
Defined in header <complex>
(A)
float       imag( float f );

double      imag( double f );

long double imag( long double f );
 (until C++14)
constexpr float       imag( float f );

constexpr double      imag( double f );

constexpr long double imag( long double f );
 (since C++14)
(until C++23)
template< class FloatingPoint >
FloatingPoint imag( FloatingPoint f );
 (since C++23)
(B)
template< class Integer >
double imag( Integer i );
 (until C++14)
template< class Integer >
constexpr double imag( Integer i );
 (since C++14)
1) Returns the imaginary part of the complex number z, i.e. z.imag().
A,B) Additional overloads are provided for all integer and floating-point types, which are treated as complex numbers with zero imaginary part.
 (since C++11)

Contents

[edit] Parameters

z - complex value
f - floating-point value
i - integer value

[edit] Return value

1) The imaginary part of z.
A) decltype(f){} (zero).
B) 0.0.

[edit] Notes

The additional overloads are not required to be provided exactly as (A,B). They only need to be sufficient to ensure that for their argument num:

  • If num has a standard(until C++23) floating-point type T, then std::imag(num) has the same effect as std::imag(std::complex<T>(num)).
  • Otherwise, if num has an integer type, then std::imag(num) has the same effect as std::imag(std::complex<double>(num)).

[edit] See also

 accesses the imaginary part of the complex number
(public member function) [edit]
returns the real part
(function template) [edit]
C documentation for cimag
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/numeric/complex/imag2&oldid=149034"