Numeric.Floating.IEEE.NaN

This module provides the typeclass for NaN manipulation: RealFloatNaN.

In addition to Float and Double, a couple of floating-point types provided by third-party libraries can be supported via package flags: Half via half and Float128 via float128.

Documentation

class RealFloat a => RealFloatNaN a where

An instance of this class supports manipulation of NaN.

Minimal complete definition

(copySign | isSignMinus), (isSignaling | classify), getPayload, setPayload, setPayloadSignaling

Methods

copySign :: a -> a -> a

Returns the first operand, with the sign of the second.

IEEE 754 copySign operation.

isSignMinus :: a -> Bool

Returns True if the operand is a negative number, negative infinity, negative zero, or a NaN with negative sign bit.

IEEE 754 isSignMinus operation.

isSignaling :: a -> Bool

Returns True if the operand is a signaling NaN.

IEEE 754 isSignaling operation.

Warning: GHC's optimizer is not aware of signaling NaNs.

getPayload :: a -> a

Returns the payload of a NaN. Returns -1 if the operand is not a NaN.

IEEE 754 getPayload operation.

setPayload :: a -> a

Returns a quiet NaN with a given payload. Returns a positive zero if the payload is invalid.

IEEE 754 setPayload operation.

setPayloadSignaling :: a -> a

Returns a signaling NaN with a given payload. Returns a positive zero if the payload is invalid.

IEEE 754 setPayloadSignaling operation.

classify :: a -> Class

IEEE 754 class operation.

equalByTotalOrder :: a -> a -> Bool

Equality with IEEE 754 totalOrder operation.

compareByTotalOrder :: a -> a -> Ordering

Comparison with IEEE 754 totalOrder operation.

Floating-point numbers should be ordered as, \(-\mathrm{qNaN} < -\mathrm{sNaN} < -\infty < \text{negative reals} < -0 < +0 < \text{positive reals} < +\infty < +\mathrm{sNaN} < +\mathrm{qNaN}\).

Instances

RealFloatNaN Double

Defined in Numeric.Floating.IEEE.Internal.NaN

Methods

copySign :: Double -> Double -> Double

isSignMinus :: Double -> Bool

isSignaling :: Double -> Bool

getPayload :: Double -> Double

setPayload :: Double -> Double

setPayloadSignaling :: Double -> Double

classify :: Double -> Class

equalByTotalOrder :: Double -> Double -> Bool

compareByTotalOrder :: Double -> Double -> Ordering

RealFloatNaN Float

Defined in Numeric.Floating.IEEE.Internal.NaN

Methods

copySign :: Float -> Float -> Float

isSignMinus :: Float -> Bool

isSignaling :: Float -> Bool

getPayload :: Float -> Float

setPayload :: Float -> Float

setPayloadSignaling :: Float -> Float

classify :: Float -> Class

equalByTotalOrder :: Float -> Float -> Bool

compareByTotalOrder :: Float -> Float -> Ordering

data Class

The classification of floating-point values.

Constructors

SignalingNaN

QuietNaN

NegativeInfinity

NegativeNormal

NegativeSubnormal

NegativeZero

PositiveZero

PositiveSubnormal

PositiveNormal

PositiveInfinity

Instances

Enum Class

Defined in Numeric.Floating.IEEE.Internal.Classify

Methods

succ :: Class -> Class

pred :: Class -> Class

toEnum :: Int -> Class

fromEnum :: Class -> Int

enumFrom :: Class -> [Class]

enumFromThen :: Class -> Class -> [Class]

enumFromTo :: Class -> Class -> [Class]

enumFromThenTo :: Class -> Class -> Class -> [Class]

Read Class

Defined in Numeric.Floating.IEEE.Internal.Classify

Methods

readsPrec :: Int -> ReadS Class

readList :: ReadS [Class]

readPrec :: ReadPrec Class

readListPrec :: ReadPrec [Class]

Show Class

Defined in Numeric.Floating.IEEE.Internal.Classify

Methods

showsPrec :: Int -> Class -> ShowS

show :: Class -> String

showList :: [Class] -> ShowS

Eq Class

Defined in Numeric.Floating.IEEE.Internal.Classify

Methods

(==) :: Class -> Class -> Bool

(/=) :: Class -> Class -> Bool

Ord Class

Defined in Numeric.Floating.IEEE.Internal.Classify

Methods

compare :: Class -> Class -> Ordering

(<) :: Class -> Class -> Bool

(<=) :: Class -> Class -> Bool

(>) :: Class -> Class -> Bool

(>=) :: Class -> Class -> Bool

max :: Class -> Class -> Class

min :: Class -> Class -> Class

newtype TotallyOrdered a

A newtype wrapper to compare floating-point numbers by totalOrder predicate.

Constructors

TotallyOrdered a

Instances

Show a => Show (TotallyOrdered a)

Defined in Numeric.Floating.IEEE.Internal.NaN

Methods

showsPrec :: Int -> TotallyOrdered a -> ShowS

show :: TotallyOrdered a -> String

showList :: [TotallyOrdered a] -> ShowS

RealFloatNaN a => Eq (TotallyOrdered a)

Defined in Numeric.Floating.IEEE.Internal.NaN

Methods

(==) :: TotallyOrdered a -> TotallyOrdered a -> Bool

(/=) :: TotallyOrdered a -> TotallyOrdered a -> Bool

RealFloatNaN a => Ord (TotallyOrdered a)

Defined in Numeric.Floating.IEEE.Internal.NaN

Methods

compare :: TotallyOrdered a -> TotallyOrdered a -> Ordering

(<) :: TotallyOrdered a -> TotallyOrdered a -> Bool

(<=) :: TotallyOrdered a -> TotallyOrdered a -> Bool

(>) :: TotallyOrdered a -> TotallyOrdered a -> Bool

(>=) :: TotallyOrdered a -> TotallyOrdered a -> Bool

max :: TotallyOrdered a -> TotallyOrdered a -> TotallyOrdered a

min :: TotallyOrdered a -> TotallyOrdered a -> TotallyOrdered a