What4.Utils.FloatHelpers

Documentation

data RoundingMode

Rounding modes for IEEE-754 floating point operations.

Constructors

RNE

Round to nearest even.

RNA

Round to nearest away.

RTP

Round toward plus Infinity.

RTN

Round toward minus Infinity.

RTZ

Round toward zero.

Instances

Enum RoundingMode

Defined in What4.Utils.FloatHelpers

Methods

succ :: RoundingMode -> RoundingMode

pred :: RoundingMode -> RoundingMode

toEnum :: Int -> RoundingMode

fromEnum :: RoundingMode -> Int

enumFrom :: RoundingMode -> [RoundingMode]

enumFromThen :: RoundingMode -> RoundingMode -> [RoundingMode]

enumFromTo :: RoundingMode -> RoundingMode -> [RoundingMode]

enumFromThenTo :: RoundingMode -> RoundingMode -> RoundingMode -> [RoundingMode]

Eq RoundingMode

Defined in What4.Utils.FloatHelpers

Methods

(==) :: RoundingMode -> RoundingMode -> Bool

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

Ord RoundingMode

Defined in What4.Utils.FloatHelpers

Methods

compare :: RoundingMode -> RoundingMode -> Ordering

(<) :: RoundingMode -> RoundingMode -> Bool

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

(>) :: RoundingMode -> RoundingMode -> Bool

(>=) :: RoundingMode -> RoundingMode -> Bool

max :: RoundingMode -> RoundingMode -> RoundingMode

min :: RoundingMode -> RoundingMode -> RoundingMode

Show RoundingMode

Defined in What4.Utils.FloatHelpers

Methods

showsPrec :: Int -> RoundingMode -> ShowS

show :: RoundingMode -> String

showList :: [RoundingMode] -> ShowS

Generic RoundingMode

Defined in What4.Utils.FloatHelpers

Associated Types

type Rep RoundingMode :: Type -> Type

Methods

from :: RoundingMode -> Rep RoundingMode x

to :: Rep RoundingMode x -> RoundingMode

Hashable RoundingMode

Defined in What4.Utils.FloatHelpers

Methods

hashWithSalt :: Int -> RoundingMode -> Int

hash :: RoundingMode -> Int

type Rep RoundingMode

Defined in What4.Utils.FloatHelpers

type Rep RoundingMode = D1 ('MetaData "RoundingMode" "What4.Utils.FloatHelpers" "what4-1.2.1-1UHqyVyvUUy5vokVHWhi5d" 'False) ((C1 ('MetaCons "RNE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RNA" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "RTP" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "RTN" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RTZ" 'PrefixI 'False) (U1 :: Type -> Type))))

bfStatus :: HasCallStack => (a, Status) -> a

fppOpts :: FloatPrecisionRepr fpp -> RoundingMode -> BFOpts

toRoundMode :: RoundingMode -> RoundMode

fpOpts :: Integer -> Integer -> RoundMode -> BFOpts

Make LibBF options for the given precision and rounding mode.

floatFromInteger :: BFOpts -> Integer -> BigFloat

Make a floating point number from an integer, using the given rounding mode

floatFromRational :: BFOpts -> Rational -> BigFloat

Make a floating point number from a rational, using the given rounding mode

floatToRational :: BigFloat -> Maybe Rational

Convert a floating point number to a rational, if possible.

floatToInteger :: RoundingMode -> BigFloat -> Maybe Integer

Convert a floating point number to an integer, if possible.

floatRoundToInt :: HasCallStack => FloatPrecisionRepr fpp -> RoundingMode -> BigFloat -> BigFloat