List of all members.
Public Types |
| typedef number | real_type |
Static Public Member Functions |
| static std::complex< number > | conjugate (const std::complex< number > &x) |
| static real_type | abs_square (const std::complex< number > &x) |
| static real_type | abs (const std::complex< number > &x) |
Static Public Attributes |
| static const bool | is_complex = true |
Detailed Description
template<typename number>
struct numbers::NumberTraits< std::complex< number > >
Specialization of the general NumberTraits class that provides the relevant information if the underlying data type is std::complex<T>.
- Author:
- Wolfgang Bangerth, 2007
Definition at line 237 of file numbers.h.
Member Typedef Documentation
template<typename number >
For this data type, typedef the corresponding real type. Since this specialization of the template is selected for number types std::complex<T>, the real type is equal to the type used to store the two components of the complex number.
Definition at line 260 of file numbers.h.
Member Function Documentation
template<typename number >
| std::complex< number > numbers::NumberTraits< std::complex< number > >::conjugate |
( |
const std::complex< number > & |
x ) |
[static] |
Return the complex-conjugate of the given number.
Definition at line 337 of file numbers.h.
template<typename number >
Return the square of the absolute value of the given number. Since this specialization of the general template is chosen for types equal to std::complex, this function returns the product of a number and its complex conjugate.
Definition at line 355 of file numbers.h.
template<typename number >
Return the absolute value of a complex number.
Definition at line 346 of file numbers.h.
Member Data Documentation
template<typename number >
A flag that specifies whether the template type given to this class is complex or real. Since this specialization of the general template is selected for complex types, the answer is true.
Definition at line 248 of file numbers.h.
The documentation for this struct was generated from the following file: