half Class Reference

#include <half.hpp>

Public Member Functions

Construction and assignment
HALF_CONSTEXPR half () HALF_NOEXCEPT
 
 half (float rhs)
 
 operator float () const
 
halfoperator= (float rhs)
 
Arithmetic updates
halfoperator+= (half rhs)
 
halfoperator-= (half rhs)
 
halfoperator*= (half rhs)
 
halfoperator/= (half rhs)
 
halfoperator+= (float rhs)
 
halfoperator-= (float rhs)
 
halfoperator*= (float rhs)
 
halfoperator/= (float rhs)
 
Increment and decrement
halfoperator++ ()
 
halfoperator-- ()
 
half operator++ (int)
 
half operator-- (int)
 

Private Member Functions

HALF_CONSTEXPR half (detail::binary_t, unsigned int bits) HALF_NOEXCEPT
 

Private Attributes

detail::uint16 data_
 Internal binary representation. More...
 

Static Private Attributes

static const std::float_round_style round_style = (std::float_round_style)(HALF_ROUND_STYLE)
 Rounding mode to use. More...
 

Friends

template<typename , typename , std::float_round_style >
struct detail::half_caster
 
class std::numeric_limits< half >
 
HALF_CONSTEXPR_NOERR bool operator== (half, half)
 
HALF_CONSTEXPR_NOERR bool operator!= (half, half)
 
HALF_CONSTEXPR_NOERR bool operator< (half, half)
 
HALF_CONSTEXPR_NOERR bool operator> (half, half)
 
HALF_CONSTEXPR_NOERR bool operator<= (half, half)
 
HALF_CONSTEXPR_NOERR bool operator>= (half, half)
 
HALF_CONSTEXPR half operator- (half)
 
half operator+ (half, half)
 
half operator- (half, half)
 
half operator* (half, half)
 
half operator/ (half, half)
 
template<typename charT , typename traits >
std::basic_ostream< charT, traits > & operator<< (std::basic_ostream< charT, traits > &, half)
 
template<typename charT , typename traits >
std::basic_istream< charT, traits > & operator>> (std::basic_istream< charT, traits > &, half &)
 
HALF_CONSTEXPR half fabs (half)
 
half fmod (half, half)
 
half remainder (half, half)
 
half remquo (half, half, int *)
 
half fma (half, half, half)
 
HALF_CONSTEXPR_NOERR half fmax (half, half)
 
HALF_CONSTEXPR_NOERR half fmin (half, half)
 
half fdim (half, half)
 
half nanh (const char *)
 
half exp (half)
 
half exp2 (half)
 
half expm1 (half)
 
half log (half)
 
half log10 (half)
 
half log2 (half)
 
half log1p (half)
 
half sqrt (half)
 
half rsqrt (half)
 
half cbrt (half)
 
half hypot (half, half)
 
half hypot (half, half, half)
 
half pow (half, half)
 
void sincos (half, half *, half *)
 
half sin (half)
 
half cos (half)
 
half tan (half)
 
half asin (half)
 
half acos (half)
 
half atan (half)
 
half atan2 (half, half)
 
half sinh (half)
 
half cosh (half)
 
half tanh (half)
 
half asinh (half)
 
half acosh (half)
 
half atanh (half)
 
half erf (half)
 
half erfc (half)
 
half lgamma (half)
 
half tgamma (half)
 
half ceil (half)
 
half floor (half)
 
half trunc (half)
 
half round (half)
 
long lround (half)
 
half rint (half)
 
long lrint (half)
 
half nearbyint (half)
 
half frexp (half, int *)
 
half scalbln (half, long)
 
half modf (half, half *)
 
int ilogb (half)
 
half logb (half)
 
half nextafter (half, half)
 
half nexttoward (half, long double)
 
HALF_CONSTEXPR half copysign (half, half)
 
HALF_CONSTEXPR int fpclassify (half)
 
HALF_CONSTEXPR bool isfinite (half)
 
HALF_CONSTEXPR bool isinf (half)
 
HALF_CONSTEXPR bool isnan (half)
 
HALF_CONSTEXPR bool isnormal (half)
 
HALF_CONSTEXPR bool signbit (half)
 
HALF_CONSTEXPR bool isgreater (half, half)
 
HALF_CONSTEXPR bool isgreaterequal (half, half)
 
HALF_CONSTEXPR bool isless (half, half)
 
HALF_CONSTEXPR bool islessequal (half, half)
 
HALF_CONSTEXPR bool islessgreater (half, half)
 

Detailed Description

Half-precision floating-point type. This class implements an IEEE-conformant half-precision floating-point type with the usual arithmetic operators and conversions. It is implicitly convertible to single-precision floating-point, which makes artihmetic expressions and functions with mixed-type operands to be of the most precise operand type.

According to the C++98/03 definition, the half type is not a POD type. But according to C++11's less strict and extended definitions it is both a standard layout type and a trivially copyable type (even if not a POD type), which means it can be standard-conformantly copied using raw binary copies. But in this context some more words about the actual size of the type. Although the half is representing an IEEE 16-bit type, it does not neccessarily have to be of exactly 16-bits size. But on any reasonable implementation the actual binary representation of this type will most probably not ivolve any additional "magic" or padding beyond the simple binary representation of the underlying 16-bit IEEE number, even if not strictly guaranteed by the standard. But even then it only has an actual size of 16 bits if your C++ implementation supports an unsigned integer type of exactly 16 bits width. But this should be the case on nearly any reasonable platform.

So if your C++ implementation is not totally exotic or imposes special alignment requirements, it is a reasonable assumption that the data of a half is just comprised of the 2 bytes of the underlying IEEE representation.

Definition at line 2055 of file half.hpp.

Constructor & Destructor Documentation

◆ half() [1/3]

HALF_CONSTEXPR half ( )
inline

Default constructor. This initializes the half to 0. Although this does not match the builtin types' default-initialization semantics and may be less efficient than no initialization, it is needed to provide proper value-initialization semantics.

Definition at line 2064 of file half.hpp.

◆ half() [2/3]

half ( float  rhs)
inlineexplicit

Conversion constructor.

Parameters
rhsfloat to convert
Exceptions
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2069 of file half.hpp.

◆ half() [3/3]

HALF_CONSTEXPR half ( detail::binary_t  ,
unsigned int  bits 
)
inlineprivate

Constructor.

Parameters
bitsbinary representation to set half to

Definition at line 2168 of file half.hpp.

Member Function Documentation

◆ operator float()

operator float ( ) const
inline

Conversion to single-precision.

Returns
single precision value representing expression value

Definition at line 2073 of file half.hpp.

◆ operator*=() [1/2]

half & operator*= ( float  rhs)
inline

Arithmetic assignment.

Parameters
rhssingle-precision value to multiply with
Returns
reference to this half
Exceptions
FE_...according to operator=()

Definition at line 2129 of file half.hpp.

◆ operator*=() [2/2]

half & operator*= ( half  rhs)
inline

Arithmetic assignment.

Template Parameters
Ttype of concrete half expression
Parameters
rhshalf expression to multiply with
Returns
reference to this half
Exceptions
FE_...according to operator*(half,half)

Definition at line 2104 of file half.hpp.

◆ operator++() [1/2]

half & operator++ ( )
inline

Prefix increment.

Returns
incremented half value
Exceptions
FE_...according to operator+(half,half)

Definition at line 2144 of file half.hpp.

◆ operator++() [2/2]

half operator++ ( int  )
inline

Postfix increment.

Returns
non-incremented half value
Exceptions
FE_...according to operator+(half,half)

Definition at line 2154 of file half.hpp.

◆ operator+=() [1/2]

half & operator+= ( float  rhs)
inline

Arithmetic assignment.

Parameters
rhssingle-precision value to add
Returns
reference to this half
Exceptions
FE_...according to operator=()

Definition at line 2117 of file half.hpp.

◆ operator+=() [2/2]

half & operator+= ( half  rhs)
inline

Arithmetic assignment.

Template Parameters
Ttype of concrete half expression
Parameters
rhshalf expression to add
Returns
reference to this half
Exceptions
FE_...according to operator+(half,half)

Definition at line 2090 of file half.hpp.

◆ operator--() [1/2]

half & operator-- ( )
inline

Prefix decrement.

Returns
decremented half value
Exceptions
FE_...according to operator-(half,half)

Definition at line 2149 of file half.hpp.

◆ operator--() [2/2]

half operator-- ( int  )
inline

Postfix decrement.

Returns
non-decremented half value
Exceptions
FE_...according to operator-(half,half)

Definition at line 2159 of file half.hpp.

◆ operator-=() [1/2]

half & operator-= ( float  rhs)
inline

Arithmetic assignment.

Parameters
rhssingle-precision value to subtract
Returns
reference to this half
Exceptions
FE_...according to operator=()

Definition at line 2123 of file half.hpp.

◆ operator-=() [2/2]

half & operator-= ( half  rhs)
inline

Arithmetic assignment.

Template Parameters
Ttype of concrete half expression
Parameters
rhshalf expression to subtract
Returns
reference to this half
Exceptions
FE_...according to operator-(half,half)

Definition at line 2097 of file half.hpp.

◆ operator/=() [1/2]

half & operator/= ( float  rhs)
inline

Arithmetic assignment.

Parameters
rhssingle-precision value to divide by
Returns
reference to this half
Exceptions
FE_...according to operator=()

Definition at line 2135 of file half.hpp.

◆ operator/=() [2/2]

half & operator/= ( half  rhs)
inline

Arithmetic assignment.

Template Parameters
Ttype of concrete half expression
Parameters
rhshalf expression to divide by
Returns
reference to this half
Exceptions
FE_...according to operator/(half,half)

Definition at line 2111 of file half.hpp.

◆ operator=()

half & operator= ( float  rhs)
inline

Assignment operator.

Parameters
rhssingle-precision value to copy from
Returns
reference to this half
Exceptions
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2079 of file half.hpp.

Friends And Related Function Documentation

◆ acos

half acos ( half  arg)
friend

Arc cosine function. This function is exact to rounding for all rounding modes.

See also: Documentation for std::acos.

Parameters
argfunction argument
Returns
arc cosine value of arg
Exceptions
FE_INVALIDfor signaling NaN or if abs(arg) > 1
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3683 of file half.hpp.

◆ acosh

half acosh ( half  arg)
friend

Hyperbolic area cosine. This function is exact to rounding for all rounding modes.

See also: Documentation for std::acosh.

Parameters
argfunction argument
Returns
area cosine value of arg
Exceptions
FE_INVALIDfor signaling NaN or arguments <1
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3908 of file half.hpp.

◆ asin

half asin ( half  arg)
friend

Arc sine. This function is exact to rounding for all rounding modes.

See also: Documentation for std::asin.

Parameters
argfunction argument
Returns
arc sine value of arg
Exceptions
FE_INVALIDfor signaling NaN or if abs(arg) > 1
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3654 of file half.hpp.

◆ asinh

half asinh ( half  arg)
friend

Hyperbolic area sine. This function is exact to rounding for all rounding modes.

See also: Documentation for std::asinh.

Parameters
argfunction argument
Returns
area sine value of arg
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3880 of file half.hpp.

◆ atan

half atan ( half  arg)
friend

Arc tangent function. This function is exact to rounding for all rounding modes.

See also: Documentation for std::atan.

Parameters
argfunction argument
Returns
arc tangent value of arg
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3708 of file half.hpp.

◆ atan2

half atan2 ( half  y,
half  x 
)
friend

Arc tangent function. This function may be 1 ULP off the correctly rounded exact result in ~0.005% of inputs for std::round_to_nearest, in ~0.1% of inputs for std::round_toward_zero and in ~0.02% of inputs for any other rounding mode.

See also: Documentation for std::atan2.

Parameters
ynumerator
xdenominator
Returns
arc tangent value
Exceptions
FE_INVALIDif x or y is signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3738 of file half.hpp.

◆ atanh

half atanh ( half  arg)
friend

Hyperbolic area tangent. This function is exact to rounding for all rounding modes.

See also: Documentation for std::atanh.

Parameters
argfunction argument
Returns
area tangent value of arg
Exceptions
FE_INVALIDfor signaling NaN or if abs(arg) > 1
FE_DIVBYZEROfor +/-1
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3933 of file half.hpp.

◆ cbrt

half cbrt ( half  arg)
friend

Cubic root. This function is exact to rounding for all rounding modes.

See also: Documentation for std::cbrt.

Parameters
argfunction argument
Returns
cubic root of arg
Exceptions
FE_INVALIDfor signaling NaN
FE_INEXACTaccording to rounding

Definition at line 3264 of file half.hpp.

◆ ceil

half ceil ( half  arg)
friend

Nearest integer not less than half value. See also: Documentation for std::ceil.

Parameters
arghalf to round
Returns
nearest integer not less than arg
Exceptions
FE_INVALIDfor signaling NaN
FE_INEXACTif value had to be rounded

Definition at line 4071 of file half.hpp.

◆ copysign

HALF_CONSTEXPR half copysign ( half  x,
half  y 
)
friend

Take sign. See also: Documentation for std::copysign.

Parameters
xvalue to change sign for
yvalue to take sign from
Returns
value equal to x in magnitude and to y in sign

Definition at line 4342 of file half.hpp.

◆ cos

half cos ( half  arg)
friend

Cosine function. This function is exact to rounding for all rounding modes.

See also: Documentation for std::cos.

Parameters
argfunction argument
Returns
cosine value of arg
Exceptions
FE_INVALIDfor signaling NaN or infinity
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3589 of file half.hpp.

◆ cosh

half cosh ( half  arg)
friend

Hyperbolic cosine. This function is exact to rounding for all rounding modes.

See also: Documentation for std::cosh.

Parameters
argfunction argument
Returns
hyperbolic cosine value of arg
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3821 of file half.hpp.

◆ detail::half_caster

friend struct detail::half_caster
friend

Definition at line 2258 of file half.hpp.

◆ erf

half erf ( half  arg)
friend

Error function. This function may be 1 ULP off the correctly rounded exact result for any rounding mode in <0.5% of inputs.

See also: Documentation for std::erf.

Parameters
argfunction argument
Returns
error function value of arg
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3966 of file half.hpp.

◆ erfc

half erfc ( half  arg)
friend

Complementary error function. This function may be 1 ULP off the correctly rounded exact result for any rounding mode in <0.5% of inputs.

See also: Documentation for std::erfc.

Parameters
argfunction argument
Returns
1 minus error function value of arg
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3988 of file half.hpp.

◆ exp

half exp ( half  arg)
friend

Exponential function. This function is exact to rounding for all rounding modes.

See also: Documentation for std::exp.

Parameters
argfunction argument
Returns
e raised to arg
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2936 of file half.hpp.

◆ exp2

half exp2 ( half  arg)
friend

Binary exponential. This function is exact to rounding for all rounding modes.

See also: Documentation for std::exp2.

Parameters
argfunction argument
Returns
2 raised to arg
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2971 of file half.hpp.

◆ expm1

half expm1 ( half  arg)
friend

Exponential minus one. This function may be 1 ULP off the correctly rounded exact result in <0.05% of inputs for std::round_to_nearest and in <1% of inputs for any other rounding mode.

See also: Documentation for std::expm1.

Parameters
argfunction argument
Returns
e raised to arg and subtracted by 1
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2997 of file half.hpp.

◆ fabs

HALF_CONSTEXPR half fabs ( half  arg)
friend

Absolute value. See also: Documentation for std::fabs.

Parameters
argoperand
Returns
absolute value of arg

Definition at line 2729 of file half.hpp.

◆ fdim

half fdim ( half  x,
half  y 
)
friend

Positive difference. This function is exact to rounding for all rounding modes.

See also: Documentation for std::fdim.

Parameters
xfirst operand
ysecond operand
Returns
x - y or 0 if difference negative
Exceptions
FE_...according to operator-(half,half)

Definition at line 2904 of file half.hpp.

◆ floor

half floor ( half  arg)
friend

Nearest integer not greater than half value. See also: Documentation for std::floor.

Parameters
arghalf to round
Returns
nearest integer not greater than arg
Exceptions
FE_INVALIDfor signaling NaN
FE_INEXACTif value had to be rounded

Definition at line 4079 of file half.hpp.

◆ fma

half fma ( half  x,
half  y,
half  z 
)
friend

Fused multiply add. This function is exact to rounding for all rounding modes.

See also: Documentation for std::fma.

Parameters
xfirst operand
ysecond operand
zthird operand
Returns
( x * y ) + z rounded as one operation.
Exceptions
FE_INVALIDaccording to operator*() and operator+() unless any argument is a quiet NaN and no argument is a signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding the final addition

Definition at line 2809 of file half.hpp.

◆ fmax

HALF_CONSTEXPR_NOERR half fmax ( half  x,
half  y 
)
friend

Maximum of half expressions. See also: Documentation for std::fmax.

Parameters
xfirst operand
ysecond operand
Returns
maximum of operands, ignoring quiet NaNs
Exceptions
FE_INVALIDif x or y is signaling NaN

Definition at line 2878 of file half.hpp.

◆ fmin

HALF_CONSTEXPR_NOERR half fmin ( half  x,
half  y 
)
friend

Minimum of half expressions. See also: Documentation for std::fmin.

Parameters
xfirst operand
ysecond operand
Returns
minimum of operands, ignoring quiet NaNs
Exceptions
FE_INVALIDif x or y is signaling NaN

Definition at line 2890 of file half.hpp.

◆ fmod

half fmod ( half  x,
half  y 
)
friend

Remainder of division. See also: Documentation for std::fmod.

Parameters
xfirst operand
ysecond operand
Returns
remainder of floating-point division.
Exceptions
FE_INVALIDif x is infinite or y is 0 or if x or y is signaling NaN

Definition at line 2743 of file half.hpp.

◆ fpclassify

HALF_CONSTEXPR int fpclassify ( half  arg)
friend

Classify floating-point value. See also: Documentation for std::fpclassify.

Parameters
argnumber to classify
Return values
FP_ZEROfor positive and negative zero
FP_SUBNORMALfor subnormal numbers
FP_INFINITYfor positive and negative infinity
FP_NANfor NaNs
FP_NORMALfor all other (normal) values

Definition at line 4357 of file half.hpp.

◆ frexp

half frexp ( half  arg,
int *  exp 
)
friend

Decompress floating-point number. See also: Documentation for std::frexp.

Parameters
argnumber to decompress
expaddress to store exponent at
Returns
significant in range [0.5, 1)
Exceptions
FE_INVALIDfor signaling NaN

Definition at line 4154 of file half.hpp.

◆ hypot [1/2]

half hypot ( half  x,
half  y 
)
friend

Hypotenuse function. This function is exact to rounding for all rounding modes.

See also: Documentation for std::hypot.

Parameters
xfirst argument
ysecond argument
Returns
square root of sum of squares without internal over- or underflows
Exceptions
FE_INVALIDif x or y is signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding of the final square root

Definition at line 3315 of file half.hpp.

◆ hypot [2/2]

half hypot ( half  x,
half  y,
half  z 
)
friend

Hypotenuse function. This function is exact to rounding for all rounding modes.

See also: Documentation for std::hypot.

Parameters
xfirst argument
ysecond argument
zthird argument
Returns
square root of sum of squares without internal over- or underflows
Exceptions
FE_INVALIDif x, y or z is signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding of the final square root

Definition at line 3361 of file half.hpp.

◆ ilogb

int ilogb ( half  arg)
friend

Extract exponent. See also: Documentation for std::ilogb.

Parameters
argnumber to query
Returns
floating-point exponent
Return values
FP_ILOGB0for zero
FP_ILOGBNANfor NaN
INT_MAXfor infinity
Exceptions
FE_INVALIDfor 0 or infinite values

Definition at line 4247 of file half.hpp.

◆ isfinite

HALF_CONSTEXPR bool isfinite ( half  arg)
friend

Check if finite number. See also: Documentation for std::isfinite.

Parameters
argnumber to check
Return values
trueif neither infinity nor NaN
falseelse

Definition at line 4371 of file half.hpp.

◆ isgreater

HALF_CONSTEXPR bool isgreater ( half  x,
half  y 
)
friend

Quiet comparison for greater than. See also: Documentation for std::isgreater.

Parameters
xfirst operand
ysecond operand
Return values
trueif x greater than y
falseelse

Definition at line 4412 of file half.hpp.

◆ isgreaterequal

HALF_CONSTEXPR bool isgreaterequal ( half  x,
half  y 
)
friend

Quiet comparison for greater equal. See also: Documentation for std::isgreaterequal.

Parameters
xfirst operand
ysecond operand
Return values
trueif x greater equal y
falseelse

Definition at line 4423 of file half.hpp.

◆ isinf

HALF_CONSTEXPR bool isinf ( half  arg)
friend

Check for infinity. See also: Documentation for std::isinf.

Parameters
argnumber to check
Return values
truefor positive or negative infinity
falseelse

Definition at line 4378 of file half.hpp.

◆ isless

HALF_CONSTEXPR bool isless ( half  x,
half  y 
)
friend

Quiet comparison for less than. See also: Documentation for std::isless.

Parameters
xfirst operand
ysecond operand
Return values
trueif x less than y
falseelse

Definition at line 4434 of file half.hpp.

◆ islessequal

HALF_CONSTEXPR bool islessequal ( half  x,
half  y 
)
friend

Quiet comparison for less equal. See also: Documentation for std::islessequal.

Parameters
xfirst operand
ysecond operand
Return values
trueif x less equal y
falseelse

Definition at line 4445 of file half.hpp.

◆ islessgreater

HALF_CONSTEXPR bool islessgreater ( half  x,
half  y 
)
friend

Quiet comarison for less or greater. See also: Documentation for std::islessgreater.

Parameters
xfirst operand
ysecond operand
Return values
trueif either less or greater
falseelse

Definition at line 4456 of file half.hpp.

◆ isnan

HALF_CONSTEXPR bool isnan ( half  arg)
friend

Check for NaN. See also: Documentation for std::isnan.

Parameters
argnumber to check
Return values
truefor NaNs
falseelse

Definition at line 4385 of file half.hpp.

◆ isnormal

HALF_CONSTEXPR bool isnormal ( half  arg)
friend

Check if normal number. See also: Documentation for std::isnormal.

Parameters
argnumber to check
Return values
trueif normal number
falseif either subnormal, zero, infinity or NaN

Definition at line 4392 of file half.hpp.

◆ lgamma

half lgamma ( half  arg)
friend

Natural logarithm of gamma function. This function may be 1 ULP off the correctly rounded exact result for any rounding mode in ~0.025% of inputs.

See also: Documentation for std::lgamma.

Parameters
argfunction argument
Returns
natural logarith of gamma function for arg
Exceptions
FE_INVALIDfor signaling NaN
FE_DIVBYZEROfor 0 or negative integer arguments
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 4013 of file half.hpp.

◆ log

half log ( half  arg)
friend

Natural logarithm. This function is exact to rounding for all rounding modes.

See also: Documentation for std::log.

Parameters
argfunction argument
Returns
logarithm of arg to base e
Exceptions
FE_INVALIDfor signaling NaN or negative argument
FE_DIVBYZEROfor 0
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3050 of file half.hpp.

◆ log10

half log10 ( half  arg)
friend

Common logarithm. This function is exact to rounding for all rounding modes.

See also: Documentation for std::log10.

Parameters
argfunction argument
Returns
logarithm of arg to base 10
Exceptions
FE_INVALIDfor signaling NaN or negative argument
FE_DIVBYZEROfor 0
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3078 of file half.hpp.

◆ log1p

half log1p ( half  arg)
friend

Natural logarithm plus one. This function may be 1 ULP off the correctly rounded exact result in <0.05% of inputs for std::round_to_nearest and in ~1% of inputs for any other rounding mode.

See also: Documentation for std::log1p.

Parameters
argfunction argument
Returns
logarithm of arg plus 1 to base e
Exceptions
FE_INVALIDfor signaling NaN or argument <-1
FE_DIVBYZEROfor -1
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3156 of file half.hpp.

◆ log2

half log2 ( half  arg)
friend

Binary logarithm. This function is exact to rounding for all rounding modes.

See also: Documentation for std::log2.

Parameters
argfunction argument
Returns
logarithm of arg to base 2
Exceptions
FE_INVALIDfor signaling NaN or negative argument
FE_DIVBYZEROfor 0
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3113 of file half.hpp.

◆ logb

half logb ( half  arg)
friend

Extract exponent. See also: Documentation for std::logb.

Parameters
argnumber to query
Returns
floating-point exponent
Exceptions
FE_INVALIDfor signaling NaN
FE_DIVBYZEROfor 0

Definition at line 4265 of file half.hpp.

◆ lrint

long lrint ( half  arg)
friend

Nearest integer using half's internal rounding mode. See also: Documentation for std::lrint.

Parameters
arghalf expression to round
Returns
nearest integer using default rounding mode
Exceptions
FE_INVALIDif value is not representable as long
FE_INEXACTif value had to be rounded

Definition at line 4118 of file half.hpp.

◆ lround

long lround ( half  arg)
friend

Nearest integer. See also: Documentation for std::lround.

Parameters
arghalf to round
Returns
nearest integer, rounded away from zero in half-way cases
Exceptions
FE_INVALIDif value is not representable as long

Definition at line 4102 of file half.hpp.

◆ modf

half modf ( half  arg,
half iptr 
)
friend

Extract integer and fractional parts. See also: Documentation for std::modf.

Parameters
argnumber to decompress
iptraddress to store integer part at
Returns
fractional part
Exceptions
FE_INVALIDfor signaling NaN

Definition at line 4219 of file half.hpp.

◆ nanh

half nanh ( const char *  arg)
friend

Get NaN value. See also: Documentation for std::nan.

Parameters
argstring code
Returns
quiet NaN

Definition at line 2915 of file half.hpp.

◆ nearbyint

half nearbyint ( half  arg)
friend

Nearest integer using half's internal rounding mode. See also: Documentation for std::nearbyint.

Parameters
arghalf expression to round
Returns
nearest integer using default rounding mode
Exceptions
FE_INVALIDfor signaling NaN

Definition at line 4125 of file half.hpp.

◆ nextafter

half nextafter ( half  from,
half  to 
)
friend

Next representable value. See also: Documentation for std::nextafter.

Parameters
fromvalue to compute next representable value for
todirection towards which to compute next value
Returns
next representable value after from in direction towards to
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOWfor infinite result from finite argument
FE_UNDERFLOWfor subnormal result

Definition at line 4291 of file half.hpp.

◆ nexttoward

half nexttoward ( half  from,
long double  to 
)
friend

Next representable value. See also: Documentation for std::nexttoward.

Parameters
fromvalue to compute next representable value for
todirection towards which to compute next value
Returns
next representable value after from in direction towards to
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOWfor infinite result from finite argument
FE_UNDERFLOWfor subnormal result

Definition at line 4318 of file half.hpp.

◆ operator!=

HALF_CONSTEXPR_NOERR bool operator!= ( half  x,
half  y 
)
friend

Comparison for inequality.

Parameters
xfirst operand
ysecond operand
Return values
trueif operands not equal
falseelse
Exceptions
FE_INVALIDif x or y is NaN

Definition at line 2477 of file half.hpp.

◆ operator*

half operator* ( half  x,
half  y 
)
friend

Multiplication. This operation is exact to rounding for all rounding modes.

Parameters
xleft operand
yright operand
Returns
product of half expressions
Exceptions
FE_INVALIDif multiplying 0 with infinity or if x or y is signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2618 of file half.hpp.

◆ operator+

half operator+ ( half  x,
half  y 
)
friend

Addition. This operation is exact to rounding for all rounding modes.

Parameters
xleft operand
yright operand
Returns
sum of half expressions
Exceptions
FE_INVALIDif x and y are infinities with different signs or signaling NaNs
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2552 of file half.hpp.

◆ operator- [1/2]

HALF_CONSTEXPR half operator- ( half  arg)
friend

Negation.

Parameters
argoperand
Returns
negated operand

Definition at line 2543 of file half.hpp.

◆ operator- [2/2]

half operator- ( half  x,
half  y 
)
friend

Subtraction. This operation is exact to rounding for all rounding modes.

Parameters
xleft operand
yright operand
Returns
difference of half expressions
Exceptions
FE_INVALIDif x and y are infinities with equal signs or signaling NaNs
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2602 of file half.hpp.

◆ operator/

half operator/ ( half  x,
half  y 
)
friend

Division. This operation is exact to rounding for all rounding modes.

Parameters
xleft operand
yright operand
Returns
quotient of half expressions
Exceptions
FE_INVALIDif dividing 0s or infinities with each other or if x or y is signaling NaN
FE_DIVBYZEROif dividing finite value by 0
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2651 of file half.hpp.

◆ operator<

HALF_CONSTEXPR_NOERR bool operator< ( half  x,
half  y 
)
friend

Comparison for less than.

Parameters
xfirst operand
ysecond operand
Return values
trueif x less than y
falseelse
Exceptions
FE_INVALIDif x or y is NaN

Definition at line 2488 of file half.hpp.

◆ operator<<

std::basic_ostream< charT, traits > & operator<< ( std::basic_ostream< charT, traits > &  out,
half  arg 
)
friend

Output operator. This uses the built-in functionality for streaming out floating-point numbers.

Parameters
outoutput stream to write into
arghalf expression to write
Returns
reference to output stream

Definition at line 2651 of file half.hpp.

◆ operator<=

HALF_CONSTEXPR_NOERR bool operator<= ( half  x,
half  y 
)
friend

Comparison for less equal.

Parameters
xfirst operand
ysecond operand
Return values
trueif x less equal y
falseelse
Exceptions
FE_INVALIDif x or y is NaN

Definition at line 2512 of file half.hpp.

◆ operator==

HALF_CONSTEXPR_NOERR bool operator== ( half  x,
half  y 
)
friend

Comparison for equality.

Parameters
xfirst operand
ysecond operand
Return values
trueif operands equal
falseelse
Exceptions
FE_INVALIDif x or y is NaN

Definition at line 2466 of file half.hpp.

◆ operator>

HALF_CONSTEXPR_NOERR bool operator> ( half  x,
half  y 
)
friend

Comparison for greater than.

Parameters
xfirst operand
ysecond operand
Return values
trueif x greater than y
falseelse
Exceptions
FE_INVALIDif x or y is NaN

Definition at line 2500 of file half.hpp.

◆ operator>=

HALF_CONSTEXPR_NOERR bool operator>= ( half  x,
half  y 
)
friend

Comparison for greater equal.

Parameters
xfirst operand
ysecond operand
Return values
trueif x greater equal y
falseelse
Exceptions
FE_INVALIDif x or y is NaN

Definition at line 2524 of file half.hpp.

◆ operator>>

std::basic_istream< charT, traits > & operator>> ( std::basic_istream< charT, traits > &  in,
half arg 
)
friend

Input operator. This uses the built-in functionality for streaming in floating-point numbers, specifically double precision floating point numbers (unless overridden with HALF_ARITHMETIC_TYPE). So the input string is first rounded to double precision using the underlying platform's current floating-point rounding mode before being rounded to half-precision using the library's half-precision rounding mode.

Parameters
ininput stream to read from
arghalf to read into
Returns
reference to input stream
Exceptions
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 2708 of file half.hpp.

◆ pow

half pow ( half  x,
half  y 
)
friend

Power function. This function may be 1 ULP off the correctly rounded exact result for any rounding mode in ~0.00025% of inputs.

See also: Documentation for std::pow.

Parameters
xbase
yexponent
Returns
x raised to y
Exceptions
FE_INVALIDif x or y is signaling NaN or if x is finite an negative and y is finite and not integral
FE_DIVBYZEROif x is 0 and y is negative
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3427 of file half.hpp.

◆ remainder

half remainder ( half  x,
half  y 
)
friend

Remainder of division. See also: Documentation for std::remainder.

Parameters
xfirst operand
ysecond operand
Returns
remainder of floating-point division.
Exceptions
FE_INVALIDif x is infinite or y is 0 or if x or y is signaling NaN

Definition at line 2764 of file half.hpp.

◆ remquo

half remquo ( half  x,
half  y,
int *  quo 
)
friend

Remainder of division. See also: Documentation for std::remquo.

Parameters
xfirst operand
ysecond operand
quoaddress to store some bits of quotient at
Returns
remainder of floating-point division.
Exceptions
FE_INVALIDif x is infinite or y is 0 or if x or y is signaling NaN

Definition at line 2784 of file half.hpp.

◆ rint

half rint ( half  arg)
friend

Nearest integer using half's internal rounding mode. See also: Documentation for std::rint.

Parameters
arghalf expression to round
Returns
nearest integer using default rounding mode
Exceptions
FE_INVALIDfor signaling NaN
FE_INEXACTif value had to be rounded

Definition at line 4110 of file half.hpp.

◆ round

half round ( half  arg)
friend

Nearest integer. See also: Documentation for std::round.

Parameters
arghalf to round
Returns
nearest integer, rounded away from zero in half-way cases
Exceptions
FE_INVALIDfor signaling NaN
FE_INEXACTif value had to be rounded

Definition at line 4095 of file half.hpp.

◆ rsqrt

half rsqrt ( half  arg)
friend

Inverse square root. This function is exact to rounding for all rounding modes and thus generally more accurate than directly computing 1 / sqrt(arg) in half-precision, in addition to also being faster.

Parameters
argfunction argument
Returns
reciprocal of square root of arg
Exceptions
FE_INVALIDfor signaling NaN and negative arguments
FE_INEXACTaccording to rounding

Definition at line 3227 of file half.hpp.

◆ scalbln

half scalbln ( half  arg,
long  exp 
)
friend

Multiply by power of two. This function is exact to rounding for all rounding modes.

See also: Documentation for std::scalbln.

Parameters
argnumber to modify
exppower of two to multiply with
Returns
arg multplied by 2 raised to exp
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 4174 of file half.hpp.

◆ signbit

HALF_CONSTEXPR bool signbit ( half  arg)
friend

Check sign. See also: Documentation for std::signbit.

Parameters
argnumber to check
Return values
truefor negative number
falsefor positive number

Definition at line 4399 of file half.hpp.

◆ sin

half sin ( half  arg)
friend

Sine function. This function is exact to rounding for all rounding modes.

See also: Documentation for std::sin.

Parameters
argfunction argument
Returns
sine value of arg
Exceptions
FE_INVALIDfor signaling NaN or infinity
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3556 of file half.hpp.

◆ sincos

void sincos ( half  arg,
half sin,
half cos 
)
friend

Compute sine and cosine simultaneously. This returns the same results as sin() and cos() but is faster than calling each function individually.

This function is exact to rounding for all rounding modes.

Parameters
argfunction argument
sinvariable to take sine of arg
cosvariable to take cosine of arg
Exceptions
FE_INVALIDfor signaling NaN or infinity
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3491 of file half.hpp.

◆ sinh

half sinh ( half  arg)
friend

Hyperbolic sine. This function is exact to rounding for all rounding modes.

See also: Documentation for std::sinh.

Parameters
argfunction argument
Returns
hyperbolic sine value of arg
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3793 of file half.hpp.

◆ sqrt

half sqrt ( half  arg)
friend

Square root. This function is exact to rounding for all rounding modes.

See also: Documentation for std::sqrt.

Parameters
argfunction argument
Returns
square root of arg
Exceptions
FE_INVALIDfor signaling NaN and negative arguments
FE_INEXACTaccording to rounding

Definition at line 3206 of file half.hpp.

◆ std::numeric_limits< half >

friend class std::numeric_limits< half >
friend

Definition at line 2258 of file half.hpp.

◆ tan

half tan ( half  arg)
friend

Tangent function. This function is exact to rounding for all rounding modes.

See also: Documentation for std::tan.

Parameters
argfunction argument
Returns
tangent value of arg
Exceptions
FE_INVALIDfor signaling NaN or infinity
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3617 of file half.hpp.

◆ tanh

half tanh ( half  arg)
friend

Hyperbolic tangent. This function is exact to rounding for all rounding modes.

See also: Documentation for std::tanh.

Parameters
argfunction argument
Returns
hyperbolic tangent value of arg
Exceptions
FE_INVALIDfor signaling NaN
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 3848 of file half.hpp.

◆ tgamma

half tgamma ( half  arg)
friend

Gamma function. This function may be 1 ULP off the correctly rounded exact result for any rounding mode in <0.25% of inputs.

See also: Documentation for std::tgamma.

Parameters
argfunction argument
Returns
gamma function value of arg
Exceptions
FE_INVALIDfor signaling NaN, negative infinity or negative integer arguments
FE_DIVBYZEROfor 0
FE_OVERFLOW,...UNDERFLOW,...INEXACTaccording to rounding

Definition at line 4038 of file half.hpp.

◆ trunc

half trunc ( half  arg)
friend

Nearest integer not greater in magnitude than half value. See also: Documentation for std::trunc.

Parameters
arghalf to round
Returns
nearest integer not greater in magnitude than arg
Exceptions
FE_INVALIDfor signaling NaN
FE_INEXACTif value had to be rounded

Definition at line 4087 of file half.hpp.

Member Data Documentation

◆ data_

detail::uint16 data_
private

Internal binary representation.

Definition at line 2171 of file half.hpp.

◆ round_style

const std::float_round_style round_style = (std::float_round_style)(HALF_ROUND_STYLE)
staticprivate

Rounding mode to use.

Definition at line 2164 of file half.hpp.


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