Blaze  3.6
Public Types | List of all members
blaze::NegativeInfinity< I > Class Template Reference

Negative infinity for built-in data types.The NegativeInfinity class is a wrapper class around the functionality of the blaze::Limits class to provide the possibility to assign negative infinity values to built-in data types. As negative infinity value, the largest possible negative value of the corresponding data type is used. In order to assign the negative infinity value, the NegativeInfinity class can be implicitly converted to all signed integral and floating point data types: More...

#include <Infinity.h>

Public Types

using PositiveType = I
 The positive infinity type.
 

Public Member Functions

Destructor
 ~NegativeInfinity ()=default
 
Conversion operators
constexpr operator signed char () const
 Conversion operator to the signed char built-in type. More...
 
constexpr operator char () const
 Conversion operator to the char built-in type. More...
 
constexpr operator wchar_t () const
 Conversion operator to the wchar_t built-in type. More...
 
constexpr operator short () const
 Conversion operator to the short built-in type. More...
 
constexpr operator int () const
 Conversion operator to the int built-in type. More...
 
constexpr operator long () const
 Conversion operator to the long built-in type. More...
 
constexpr operator float () const
 Conversion operator to the float built-in type. More...
 
constexpr operator double () const
 Conversion operator to the double built-in type. More...
 
constexpr operator long double () const
 Conversion operator to the long double built-in type. More...
 
Utility functions
template<typename T >
constexpr bool equal (const T &rhs) const
 Equality comparison to a built-in data type. More...
 
Forbidden operations
NegativeInfinityoperator= (const NegativeInfinity &)=delete
 
void * operator & () const =delete
 

Private Member Functions

Constructors
constexpr NegativeInfinity ()
 The default constructor of the NegativeInfinity class.
 
 NegativeInfinity (const NegativeInfinity &)=default
 

Detailed Description

template<typename I>
class blaze::NegativeInfinity< I >

Negative infinity for built-in data types.

The NegativeInfinity class is a wrapper class around the functionality of the blaze::Limits class to provide the possibility to assign negative infinity values to built-in data types. As negative infinity value, the largest possible negative value of the corresponding data type is used. In order to assign the negative infinity value, the NegativeInfinity class can be implicitly converted to all signed integral and floating point data types:

Note
The NegativeInfinity class is a helper class for the Infinity class. It cannot be instantiated on its own, but can only be used by the Infinity class.

Member Function Documentation

◆ equal()

template<typename I >
template<typename T >
constexpr bool blaze::NegativeInfinity< I >::equal ( const T &  rhs) const
inline

Equality comparison to a built-in data type.

This function compares built-in data types with their largest possible value. The function only works for built-in data types. The attempt to compare user-defined class types will result in a compile time error.

◆ operator char()

template<typename I >
constexpr blaze::NegativeInfinity< I >::operator char ( ) const
inline

Conversion operator to the char built-in type.

The conversion operator returns the smallest possible char value.

◆ operator double()

template<typename I >
constexpr blaze::NegativeInfinity< I >::operator double ( ) const
inline

Conversion operator to the double built-in type.

The conversion operator returns the smallest possible double value.

◆ operator float()

template<typename I >
constexpr blaze::NegativeInfinity< I >::operator float ( ) const
inline

Conversion operator to the float built-in type.

The conversion operator returns the smallest possible float value.

◆ operator int()

template<typename I >
constexpr blaze::NegativeInfinity< I >::operator int ( ) const
inline

Conversion operator to the int built-in type.

The conversion operator returns the smallest possible int value.

◆ operator long()

template<typename I >
constexpr blaze::NegativeInfinity< I >::operator long ( ) const
inline

Conversion operator to the long built-in type.

The conversion operator returns the smallest possible long value.

◆ operator long double()

template<typename I >
constexpr blaze::NegativeInfinity< I >::operator long double ( ) const
inline

Conversion operator to the long double built-in type.

The conversion operator returns the smallest possible long double value.

◆ operator short()

template<typename I >
constexpr blaze::NegativeInfinity< I >::operator short ( ) const
inline

Conversion operator to the short built-in type.

The conversion operator returns the smallest possible short value.

◆ operator signed char()

template<typename I >
constexpr blaze::NegativeInfinity< I >::operator signed char ( ) const
inline

Conversion operator to the signed char built-in type.

The conversion operator returns the smallest possible signed char value.

◆ operator wchar_t()

template<typename I >
constexpr blaze::NegativeInfinity< I >::operator wchar_t ( ) const
inline

Conversion operator to the wchar_t built-in type.

The conversion operator returns the smallest possible wchar_t value.


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