double norm( double f );
constexpr double norm( double f );
template< class FloatingPoint >
constexpr FloatingPoint norm( FloatingPoint f );
template< class Integer >
double norm( Integer i );
template< class Integer >
constexpr double norm( Integer i );
1) Returns the squared magnitude of the complex number z.
A,B) Additional overloads are provided for all integer and floating-point types, which are treated as complex numbers with zero imaginary component.
(since C++11) [edit] Parameters z - complex value f - floating-point value i - integer value [edit] Return value1) The squared magnitude of z.
A) The square of f.
B) The square of i.
[edit] NotesThe norm calculated by this function is also known as field norm or absolute square.
The Euclidean norm of a complex number is provided by std::abs, which is more costly to compute. In some situations, it may be replaced by std::norm
, for example, if abs(z1) > abs(z2) then norm(z1) > norm(z2).
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:
T
, then std::norm(num) has the same effect as std::norm(std::complex<T>(num)).#include <cassert> #include <complex> #include <iostream> int main() { constexpr std::complex<double> z {3.0, 4.0}; static_assert(std::norm(z) == (z.real() * z.real() + z.imag() * z.imag())); static_assert(std::norm(z) == (z * std::conj(z))); assert(std::norm(z) == (std::abs(z) * std::abs(z))); std::cout << "std::norm(" << z << ") = " << std::norm(z) << '\n'; }
Output:
[edit] See also returns the magnitude of a complex numberRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4