Inheritance diagram for Teuchos::ScalarTraits< std::pair< Packet, Packet > >:

Public Types
typedef ScalarTraits< Packet >	PST
typedef std::pair< typename PST::magnitudeType, typename PST::magnitudeType >	magnitudeType
typedef std::pair< Packet, Packet >	magnitudeType
	Mandatory typedef for result of magnitude.
typedef std::pair< Packet, Packet >	halfPrecision
	Typedef for half precision.
typedef std::pair< Packet, Packet >	doublePrecision
	Typedef for double precision.
typedef std::pair< Packet, Packet >	coordinateType
	Typedef for coordinates.

Static Public Member Functions
static magnitudeType	magnitude (std::pair< Packet, Packet > a)
static std::pair< Packet, Packet >	zero ()
static std::pair< Packet, Packet >	one ()
static std::pair< Packet, Packet >	conjugate (std::pair< Packet, Packet > x)
static std::pair< Packet, Packet >	real (std::pair< Packet, Packet > x)
static std::pair< Packet, Packet >	imag (std::pair< Packet, Packet > x)
static bool	isnaninf (std::pair< Packet, Packet > x)
static void	seedrandom (unsigned int s)
static std::pair< Packet, Packet >	random ()
static std::string	name ()
static std::pair< Packet, Packet >	squareroot (std::pair< Packet, Packet > x)
static std::pair< Packet, Packet >	pow (std::pair< Packet, Packet > x, std::pair< Packet, Packet > y)
static magnitudeType	eps ()
	Returns relative machine precision.
static magnitudeType	sfmin ()
	Returns safe minimum (sfmin), such that 1/sfmin does not overflow.
static magnitudeType	base ()
	Returns the base of the machine.
static magnitudeType	prec ()
	Returns `eps*base`.
static magnitudeType	t ()
	Returns the number of (base) digits in the mantissa.
static magnitudeType	rnd ()
	Returns 1.0 when rounding occurs in addition, 0.0 otherwise.
static magnitudeType	emin ()
	Returns the minimum exponent before (gradual) underflow.
static magnitudeType	rmin ()
	Returns the underflow threshold - `base^`(emin-1).
static magnitudeType	emax ()
	Returns the largest exponent before overflow.
static magnitudeType	rmax ()
	Overflow theshold - (base^emax)*(1-eps).
static magnitudeType	magnitude (std::pair< Packet, Packet > a)
	Returns the magnitudeType of the scalar type `a`.
static std::pair< Packet, Packet >	zero ()
	Returns representation of zero for this scalar type.
static std::pair< Packet, Packet >	one ()
	Returns representation of one for this scalar type.
static magnitudeType	real (std::pair< Packet, Packet > a)
	Returns the real part of the scalar type `a`.
static magnitudeType	imag (std::pair< Packet, Packet > a)
	Returns the imaginary part of the scalar type `a`.
static std::pair< Packet, Packet >	conjugate (std::pair< Packet, Packet > a)
	Returns the conjugate of the scalar type `a`.
static std::pair< Packet, Packet >	nan ()
	Returns a number that represents NaN.
static bool	isnaninf (const std::pair< Packet, Packet > &x)
	Returns true if x is NaN or Inf.
static void	seedrandom (unsigned int s)
	Seed the random number generator returned by random().
static std::pair< Packet, Packet >	random ()
	Returns a random number (between -one() and +one()) of this scalar type.
static std::string	name ()
	Returns the name of this scalar type.
static std::pair< Packet, Packet >	squareroot (std::pair< Packet, Packet > x)
	Returns a number of magnitudeType that is the square root of this scalar type `x`.
static std::pair< Packet, Packet >	pow (std::pair< Packet, Packet > x, std::pair< Packet, Packet > y)
	Returns the result of raising one scalar `x` to the power `y`.
static std::pair< Packet, Packet >	pi ()
	Returns the value of PI.

Static Public Attributes
static const bool	isComplex = PST::isComplex
static const bool	isComparable = PST::isComparable
static const bool	hasMachineParameters = PST::hasMachineParameters
static const bool	isComplex
	Determines if scalar type is std::complex.
static const bool	isOrdinal
	Determines if scalar type is an ordinal type.
static const bool	isComparable
	Determines if scalar type supports relational operators such as <, >, <=, >=.
static const bool	hasMachineParameters
	Determines if scalar type have machine-specific parameters (i.e. eps(), sfmin(), base(), prec(), t(), rnd(), emin(), rmin(), emax(), rmax() are supported).

Detailed Description

template<typename Packet>
struct Teuchos::ScalarTraits< std::pair< Packet, Packet > >

Definition at line 80 of file DefaultMpiComm_UnitTests.cpp.

Member Typedef Documentation

◆ PST

template<typename Packet>

typedef ScalarTraits<Packet> Teuchos::ScalarTraits< std::pair< Packet, Packet > >::PST

Definition at line 82 of file DefaultMpiComm_UnitTests.cpp.

◆ magnitudeType [1/2]

template<typename Packet>

typedef std::pair<typename PST::magnitudeType, typename PST::magnitudeType> Teuchos::ScalarTraits< std::pair< Packet, Packet > >::magnitudeType

Definition at line 83 of file DefaultMpiComm_UnitTests.cpp.

◆ magnitudeType [2/2]

typedef std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::magnitudeType

Mandatory typedef for result of magnitude.

Definition at line 93 of file Teuchos_ScalarTraitsDecl.hpp.

◆ halfPrecision

typedef std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::halfPrecision

Typedef for half precision.

Definition at line 95 of file Teuchos_ScalarTraitsDecl.hpp.

◆ doublePrecision

typedef std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::doublePrecision

Typedef for double precision.

Definition at line 97 of file Teuchos_ScalarTraitsDecl.hpp.

◆ coordinateType

typedef std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::coordinateType

Typedef for coordinates.

Definition at line 99 of file Teuchos_ScalarTraitsDecl.hpp.

Member Function Documentation

◆ magnitude() [1/2]

template<typename Packet>

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::magnitude ( std::pair< Packet, Packet > a )

inlinestatic

Definition at line 88 of file DefaultMpiComm_UnitTests.cpp.

◆ zero() [1/2]

template<typename Packet>

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::zero ( )

inlinestatic

Definition at line 89 of file DefaultMpiComm_UnitTests.cpp.

◆ one() [1/2]

template<typename Packet>

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::one ( )

inlinestatic

Definition at line 90 of file DefaultMpiComm_UnitTests.cpp.

◆ conjugate() [1/2]

template<typename Packet>

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::conjugate ( std::pair< Packet, Packet > x )

inlinestatic

Definition at line 91 of file DefaultMpiComm_UnitTests.cpp.

◆ real() [1/2]

template<typename Packet>

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::real ( std::pair< Packet, Packet > x )

inlinestatic

Definition at line 92 of file DefaultMpiComm_UnitTests.cpp.

◆ imag() [1/2]

template<typename Packet>

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::imag ( std::pair< Packet, Packet > x )

inlinestatic

Definition at line 93 of file DefaultMpiComm_UnitTests.cpp.

◆ isnaninf() [1/2]

template<typename Packet>

bool Teuchos::ScalarTraits< std::pair< Packet, Packet > >::isnaninf ( std::pair< Packet, Packet > x )

inlinestatic

Definition at line 94 of file DefaultMpiComm_UnitTests.cpp.

◆ seedrandom() [1/2]

template<typename Packet>

void Teuchos::ScalarTraits< std::pair< Packet, Packet > >::seedrandom ( unsigned int s )

inlinestatic

Definition at line 95 of file DefaultMpiComm_UnitTests.cpp.

◆ random() [1/2]

template<typename Packet>

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::random ( )

inlinestatic

Definition at line 96 of file DefaultMpiComm_UnitTests.cpp.

◆ name() [1/2]

template<typename Packet>

std::string Teuchos::ScalarTraits< std::pair< Packet, Packet > >::name ( )

inlinestatic

Definition at line 97 of file DefaultMpiComm_UnitTests.cpp.

◆ squareroot() [1/2]

template<typename Packet>

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::squareroot ( std::pair< Packet, Packet > x )

inlinestatic

Definition at line 98 of file DefaultMpiComm_UnitTests.cpp.

◆ pow() [1/2]

template<typename Packet>

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::pow	(	std::pair< Packet, Packet >	x,
		std::pair< Packet, Packet >	y )

inlinestatic

Definition at line 99 of file DefaultMpiComm_UnitTests.cpp.

◆ eps()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::eps ( )

inlinestatic

Returns relative machine precision.

Definition at line 112 of file Teuchos_ScalarTraitsDecl.hpp.

◆ sfmin()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::sfmin ( )

inlinestatic

Returns safe minimum (sfmin), such that 1/sfmin does not overflow.

Definition at line 114 of file Teuchos_ScalarTraitsDecl.hpp.

◆ base()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::base ( )

inlinestatic

Returns the base of the machine.

Definition at line 116 of file Teuchos_ScalarTraitsDecl.hpp.

◆ prec()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::prec ( )

inlinestatic

Returns eps*base.

Definition at line 118 of file Teuchos_ScalarTraitsDecl.hpp.

◆ t()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::t ( )

inlinestatic

Returns the number of (base) digits in the mantissa.

Definition at line 120 of file Teuchos_ScalarTraitsDecl.hpp.

◆ rnd()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::rnd ( )

inlinestatic

Returns 1.0 when rounding occurs in addition, 0.0 otherwise.

Definition at line 122 of file Teuchos_ScalarTraitsDecl.hpp.

◆ emin()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::emin ( )

inlinestatic

Returns the minimum exponent before (gradual) underflow.

Definition at line 124 of file Teuchos_ScalarTraitsDecl.hpp.

◆ rmin()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::rmin ( )

inlinestatic

Returns the underflow threshold - base^(emin-1).

Definition at line 126 of file Teuchos_ScalarTraitsDecl.hpp.

◆ emax()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::emax ( )

inlinestatic

Returns the largest exponent before overflow.

Definition at line 128 of file Teuchos_ScalarTraitsDecl.hpp.

◆ rmax()

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::rmax ( )

inlinestatic

Overflow theshold - (base^emax)*(1-eps).

Definition at line 130 of file Teuchos_ScalarTraitsDecl.hpp.

◆ magnitude() [2/2]

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::magnitude ( std::pair< Packet, Packet > a )

inlinestatic

Returns the magnitudeType of the scalar type a.

Definition at line 132 of file Teuchos_ScalarTraitsDecl.hpp.

◆ zero() [2/2]

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::zero ( )

inlinestatic

Returns representation of zero for this scalar type.

Definition at line 134 of file Teuchos_ScalarTraitsDecl.hpp.

◆ one() [2/2]

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::one ( )

inlinestatic

Returns representation of one for this scalar type.

Definition at line 136 of file Teuchos_ScalarTraitsDecl.hpp.

◆ real() [2/2]

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::real ( std::pair< Packet, Packet > a )

inlinestatic

Returns the real part of the scalar type a.

Definition at line 138 of file Teuchos_ScalarTraitsDecl.hpp.

◆ imag() [2/2]

magnitudeType Teuchos::ScalarTraits< std::pair< Packet, Packet > >::imag ( std::pair< Packet, Packet > a )

inlinestatic

Returns the imaginary part of the scalar type a.

Definition at line 140 of file Teuchos_ScalarTraitsDecl.hpp.

◆ conjugate() [2/2]

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::conjugate ( std::pair< Packet, Packet > a )

inlinestatic

Returns the conjugate of the scalar type a.

Definition at line 142 of file Teuchos_ScalarTraitsDecl.hpp.

◆ nan()

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::nan ( )

inlinestatic

Returns a number that represents NaN.

Definition at line 144 of file Teuchos_ScalarTraitsDecl.hpp.

◆ isnaninf() [2/2]

bool Teuchos::ScalarTraits< std::pair< Packet, Packet > >::isnaninf ( const std::pair< Packet, Packet > & x )

inlinestatic

Returns true if x is NaN or Inf.

Definition at line 146 of file Teuchos_ScalarTraitsDecl.hpp.

◆ seedrandom() [2/2]

void Teuchos::ScalarTraits< std::pair< Packet, Packet > >::seedrandom ( unsigned int s )

inlinestatic

Seed the random number generator returned by random().

Definition at line 148 of file Teuchos_ScalarTraitsDecl.hpp.

◆ random() [2/2]

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::random ( )

inlinestatic

Returns a random number (between -one() and +one()) of this scalar type.

Definition at line 150 of file Teuchos_ScalarTraitsDecl.hpp.

◆ name() [2/2]

std::string Teuchos::ScalarTraits< std::pair< Packet, Packet > >::name ( )

inlinestatic

Returns the name of this scalar type.

Definition at line 152 of file Teuchos_ScalarTraitsDecl.hpp.

◆ squareroot() [2/2]

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::squareroot ( std::pair< Packet, Packet > x )

inlinestatic

Returns a number of magnitudeType that is the square root of this scalar type x.

Definition at line 154 of file Teuchos_ScalarTraitsDecl.hpp.

◆ pow() [2/2]

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::pow	(	std::pair< Packet, Packet >	x,
		std::pair< Packet, Packet >	y )

inlinestatic

Returns the result of raising one scalar x to the power y.

Definition at line 156 of file Teuchos_ScalarTraitsDecl.hpp.

◆ pi()

std::pair< Packet, Packet > Teuchos::ScalarTraits< std::pair< Packet, Packet > >::pi ( )

inlinestatic

Returns the value of PI.

Definition at line 158 of file Teuchos_ScalarTraitsDecl.hpp.

Member Data Documentation

◆ isComplex [1/2]

template<typename Packet>

const bool Teuchos::ScalarTraits< std::pair< Packet, Packet > >::isComplex = PST::isComplex

static

Definition at line 84 of file DefaultMpiComm_UnitTests.cpp.

◆ isComparable [1/2]

template<typename Packet>

const bool Teuchos::ScalarTraits< std::pair< Packet, Packet > >::isComparable = PST::isComparable

static

Definition at line 85 of file DefaultMpiComm_UnitTests.cpp.

◆ hasMachineParameters [1/2]

template<typename Packet>

const bool Teuchos::ScalarTraits< std::pair< Packet, Packet > >::hasMachineParameters = PST::hasMachineParameters

static

Definition at line 86 of file DefaultMpiComm_UnitTests.cpp.

◆ isComplex [2/2]

const bool Teuchos::ScalarTraits< std::pair< Packet, Packet > >::isComplex

static

Determines if scalar type is std::complex.

Definition at line 101 of file Teuchos_ScalarTraitsDecl.hpp.

◆ isOrdinal

const bool Teuchos::ScalarTraits< std::pair< Packet, Packet > >::isOrdinal

static

Determines if scalar type is an ordinal type.

Definition at line 103 of file Teuchos_ScalarTraitsDecl.hpp.

◆ isComparable [2/2]

const bool Teuchos::ScalarTraits< std::pair< Packet, Packet > >::isComparable

static

Determines if scalar type supports relational operators such as <, >, <=, >=.

Definition at line 105 of file Teuchos_ScalarTraitsDecl.hpp.

◆ hasMachineParameters [2/2]

const bool Teuchos::ScalarTraits< std::pair< Packet, Packet > >::hasMachineParameters

static

Determines if scalar type have machine-specific parameters (i.e. eps(), sfmin(), base(), prec(), t(), rnd(), emin(), rmin(), emax(), rmax() are supported).

Definition at line 110 of file Teuchos_ScalarTraitsDecl.hpp.

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

DefaultMpiComm_UnitTests.cpp

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ PST

◆ magnitudeType [1/2]

◆ magnitudeType [2/2]

◆ halfPrecision

◆ doublePrecision

◆ coordinateType

Member Function Documentation

◆ magnitude() [1/2]

◆ zero() [1/2]

◆ one() [1/2]

◆ conjugate() [1/2]

◆ real() [1/2]

◆ imag() [1/2]

◆ isnaninf() [1/2]

◆ seedrandom() [1/2]

◆ random() [1/2]

◆ name() [1/2]

◆ squareroot() [1/2]

◆ pow() [1/2]

◆ eps()

◆ sfmin()

◆ base()

◆ prec()

◆ t()

◆ rnd()

◆ emin()

◆ rmin()

◆ emax()

◆ rmax()

◆ magnitude() [2/2]

◆ zero() [2/2]

◆ one() [2/2]

◆ real() [2/2]

◆ imag() [2/2]

◆ conjugate() [2/2]

◆ nan()

◆ isnaninf() [2/2]

◆ seedrandom() [2/2]

◆ random() [2/2]

◆ name() [2/2]

◆ squareroot() [2/2]

◆ pow() [2/2]

◆ pi()

Member Data Documentation

◆ isComplex [1/2]

◆ isComparable [1/2]

◆ hasMachineParameters [1/2]

◆ isComplex [2/2]

◆ isOrdinal

◆ isComparable [2/2]

◆ hasMachineParameters [2/2]