Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x8fef28d2026-11-02Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02

Moduleghc-10.0.0.20260917GHC2024

GHC.Types.Literal.Floating

Contents

Arithmetic on floating-point literals

Synopsis

data LitFloating
data LitFloatingType
data ConstantFoldingPrecision
value floatToLitFloating
value doubleToLitFloating
value rationalToLitFloating
value unsafeLitFloatingToRational
value litFloatingToHostFloat
value litFloatingToHostDouble
value pprLitFloating
value litRationalToFloatOp
value litFloatingUnaryOp
value litFloatingBinaryOp
value litFloatingTernaryOp
value litFloatingComparisonOp
value truncateLitFloating
value decodeLitFloating
value encodeLitFloat
value encodeLitDouble
value isZeroLF
value isPositiveZeroLF
value isPositiveLF
value isOneLF
value isFiniteLF
value isPositiveZero
value litFloatingIsNonStandardNaN

Packageghc-10.0.0.20260917
Exports26
LanguageGHC2024
LicenceBSD-3-Clause
SourceFloating.hs

datadata LitFloating

Represents a known Float# or Double# literal on the target machine.

Instances6Eq, Data, Ord, Show, NFData, Binary

Eq LitFloatingDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating
This instance intentionally disagrees with the equality predicate (==) on Float or Double values: It is reflexive even on NaNs and distinguishes between positive and negative zero. Use litFloatingComparisonOp if you need to match Float or Double.
Data LitFloatingDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating
Ord LitFloatingDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating
The ordering represented by this instance is pretty arbitrary and may change without notice. Do not rely on its behavior!
Show LitFloatingDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating
NFData LitFloatingDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating
Binary LitFloatingDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating

datadata LitFloatingType

LitFloat LitDouble

Instances5Eq, Data, Ord, Show, NFData

Eq LitFloatingTypeDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating
Data LitFloatingTypeDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating
Ord LitFloatingTypeDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating
Show LitFloatingTypeDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating
NFData LitFloatingTypeDefined in ghc-10.0.0.20260917 · GHC.Types.Literal.Floating

datadata ConstantFoldingPrecision

FloatPrecision DoublePrecision ExcessPrecision

valuefloatToLitFloating :: Float -> LitFloating

valuedoubleToLitFloating :: Double -> LitFloating

valuerationalToLitFloating :: Rational -> LitFloating

valueunsafeLitFloatingToRational :: LitFloating -> Rational

Attempts to convert a LitFloating to a rational number.

Returns nonsense if its argument is a NaN or an infinity. Equates 0.0 with -0.0.

valuelitFloatingToHostFloat :: LitFloating -> Float

valuelitFloatingToHostDouble :: LitFloating -> Double

valuepprLitFloating :: LitFloatingType -> LitFloating -> SDoc

Arithmetic on floating-point literals

valuelitRationalToFloatOp :: ConstantFoldingPrecision -> Rational -> LitFloating

valuelitFloatingUnaryOp

:: ConstantFoldingPrecision
-> forall t. Fractional t => t -> t
-> LitFloating
-> LitFloating

valuelitFloatingBinaryOp

:: ConstantFoldingPrecision
-> forall t. Fractional t => t -> t -> t
-> LitFloating
-> LitFloating
-> LitFloating

valuelitFloatingTernaryOp

:: ConstantFoldingPrecision
-> forall t. Fractional t => t -> t -> t -> t
-> LitFloating
-> LitFloating
-> LitFloating
-> LitFloating

valuelitFloatingComparisonOp

:: ConstantFoldingPrecision
-> forall t. Ord t => t -> t -> res
-> LitFloating
-> LitFloating
-> res

valuetruncateLitFloating :: ConstantFoldingPrecision -> LitFloating -> Integer

valuedecodeLitFloating

valueencodeLitFloat :: Integer -> Int -> LitFloating

valueencodeLitDouble :: Integer -> Int -> LitFloating

valueisZeroLF :: LitFloating -> Bool

valueisPositiveZeroLF :: LitFloating -> Bool

valueisPositiveLF :: LitFloating -> Bool

Is this a positive floating-point value?

Handles negative zero, infinities and signed NaNs.

valueisOneLF :: LitFloating -> Bool

valueisFiniteLF :: LitFloating -> Bool

Returns True if its argument represents a real number, and False if its argument represents a NaN or an infinity.

valueisPositiveZero :: RealFloat a => a -> Bool

valuelitFloatingIsNonStandardNaN :: LitFloatingType -> LitFloating -> Bool