Reference documentation for deal.II version Git eec6dab337 2019-04-24 07:54:27 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
numbers::NumberTraits< number > Struct Template Reference

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

Inheritance diagram for numbers::NumberTraits< number >:
[legend]

Public Types

using real_type = number
 

Static Public Member Functions

static const number & conjugate (const number &x)
 
template<typename Dummy = number>
static std::enable_if< std::is_same< Dummy, number >::value &&is_cuda_compatible< Dummy >::value, real_type >::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 348 of file numbers.h.

Member Typedef Documentation

◆ real_type

template<typename number>
using numbers::NumberTraits< number >::real_type = number

For this data type, alias 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 363 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.

Note
This function can also be used in CUDA device code.

Definition at line 499 of file numbers.h.

◆ abs_square()

template<typename number>
template<typename Dummy >
std::enable_if< std::is_same< Dummy, number >::value &&!is_cuda_compatible< Dummy >::value, typename NumberTraits< number >::real_type >::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.

Note
If the template type can be used in CUDA device code, the same holds true for this function.

Definition at line 512 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 533 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 355 of file numbers.h.


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