numbers::NumberTraits< number > Struct Template Reference

#include <deal.II/base/numbers.h>

Public Types
typedef number	real_type

Static Public Member Functions
static const number &	conjugate (const number &x)
static real_type	abs_square (const number &x)
static real_type	abs (const number &x)

Static Public Attributes
static const bool	is_complex = false

Detailed Description

template<typename number>
struct numbers::NumberTraits< number >

A structure that, together with its partial specializations NumberTraits<std::complex<number> >, provides traits and member functions that make it possible to write templates that work on both real number types and complex number types. This template is mostly used to implement linear algebra classes such as vectors and matrices that work for both real and complex numbers.

Author

Wolfgang Bangerth, 2007

Definition at line 172 of file numbers.h.

Member Typedef Documentation

real_type

template<typename number>

typedef number numbers::NumberTraits< number >::real_type

For this data type, typedef the corresponding real type. Since the general template is selected for all data types that are not specializations of std::complex<T>, the underlying type must be real- values, so the real_type is equal to the underlying type.

Definition at line 187 of file numbers.h.

Member Function Documentation

conjugate()

template<typename number>

const number & numbers::NumberTraits< number >::conjugate ( const number &  x )

static

Return the complex-conjugate of the given number. Since the general template is selected if number is not a complex data type, this function simply returns the given number.

Definition at line 324 of file numbers.h.

abs_square()

template<typename number>

NumberTraits< number >::real_type numbers::NumberTraits< number >::abs_square ( const number &  x )

static

Return the square of the absolute value of the given number. Since the general template is chosen for types not equal to std::complex, this function simply returns the square of the given number.

Definition at line 333 of file numbers.h.

abs()

template<typename number>

NumberTraits< number >::real_type numbers::NumberTraits< number >::abs ( const number &  x )

static

Return the absolute value of a number.

Definition at line 342 of file numbers.h.

Member Data Documentation

is_complex

template<typename number>

const bool numbers::NumberTraits< number >::is_complex = false

static

A flag that specifies whether the template type given to this class is complex or real. Since the general template is selected for non-complex types, the answer is false.

Definition at line 179 of file numbers.h.

---

The documentation for this struct was generated from the following files:

• deal.II/base/numbers.h
• source/base/config.cc