LibBF.Mutable

Mutable big-float computation.

Allocation

newContext :: IO BFContext

Allocate a new numeric context.

data BFContext

State of the current computation context.

new :: BFContext -> IO BF

Allocate a new number. Starts off as zero.

data BF

A mutable high precision floating point number.

Assignment

setNaN :: BF -> IO ()

Assign NaN to the number.

setZero :: Sign -> BF -> IO ()

Assign a zero to the number.

setInf :: Sign -> BF -> IO ()

Assign an infinty to the number.

data Sign

Indicates if a number is positive or negative.

Constructors

Neg

Negative

Pos

Positive

Instances

Eq Sign

Defined in LibBF.Mutable

Methods

(==) :: Sign -> Sign -> Bool

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

Ord Sign

Defined in LibBF.Mutable

Methods

compare :: Sign -> Sign -> Ordering

(<) :: Sign -> Sign -> Bool

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

(>) :: Sign -> Sign -> Bool

(>=) :: Sign -> Sign -> Bool

max :: Sign -> Sign -> Sign

min :: Sign -> Sign -> Sign

Show Sign

Defined in LibBF.Mutable

Methods

showsPrec :: Int -> Sign -> ShowS

show :: Sign -> String

showList :: [Sign] -> ShowS

setWord :: Word64 -> BF -> IO ()

Assign from a word

setInt :: Int64 -> BF -> IO ()

Assign from an int

setDouble :: Double -> BF -> IO ()

Assign from a double

setInteger :: Integer -> BF -> IO ()

Set an integer. If the integer is larger than the primitive types, this does repreated Int64 additions and multiplications.

setBF

Arguments

:: BF

-> BF

This number is changed

-> IO ()

Assign from another number.

setString :: Int -> BFOpts -> String -> BF -> IO (Status, Int, Bool)

Set the value to the float parsed out of the given string. * The radix should not exceed maxRadix. * Sets the number to NaN on failure. * Assumes that characters are encoded with a single byte each. * Retruns: - Status for the conversion - How many bytes we consumed - Did we consume the whole input

Queries and Comparisons

cmpEq :: BF -> BF -> IO Bool

Check if the two numbers are equal.

cmpLT :: BF -> BF -> IO Bool

Check if the first number is strictly less than the second.

cmpLEQ :: BF -> BF -> IO Bool

Check if the first number is less than, or equal to, the second.

cmpAbs :: BF -> BF -> IO Ordering

Compare the absolute values of the two numbers. See also cmp.

cmp :: BF -> BF -> IO Ordering

Compare the two numbers. The special values are ordered like this:

• -0 < 0
• NaN == NaN
• NaN is larger than all other numbers

getSign :: BF -> IO (Maybe Sign)

Returns Nothing for NaN.

getExp :: BF -> IO (Maybe Int64)

Get the exponent of the number. Returns Nothing for inifinity, zero and NaN.

isFinite :: BF -> IO Bool

Check if the number is "normal", i.e. (not infinite or NaN)

isInf :: BF -> IO Bool

Check if the given numer is infinite.

isNaN :: BF -> IO Bool

Check if the number is NaN

isZero :: BF -> IO Bool

Check if the given number is a zero.

Arithmetic

fneg :: BF -> IO ()

Negate the number.

fadd :: BFOpts -> BF -> BF -> BF -> IO Status

Add two numbers, using the given settings, and store the result in the last.

faddInt :: BFOpts -> BF -> Int64 -> BF -> IO Status

Add a number and an int64 and store the result in the last.

fsub :: BFOpts -> BF -> BF -> BF -> IO Status

Subtract two numbers, using the given settings, and store the result in the last.

fmul :: BFOpts -> BF -> BF -> BF -> IO Status

Multiply two numbers, using the given settings, and store the result in the last.

fmulInt :: BFOpts -> BF -> Int64 -> BF -> IO Status

Multiply the number by the given int, and store the result in the second number.

fmulWord :: BFOpts -> BF -> Word64 -> BF -> IO Status

Multiply the number by the given word, and store the result in the second number.

fmul2Exp :: BFOpts -> Int -> BF -> IO Status

Multiply the number by 2^e.

ffma :: BFOpts -> BF -> BF -> BF -> BF -> IO Status

Compute the fused-multiply-add. ffma opts x y z r computes r := (x*y)+z.

fdiv :: BFOpts -> BF -> BF -> BF -> IO Status

Divide two numbers, using the given settings, and store the result in the last.

frem :: BFOpts -> BF -> BF -> BF -> IO Status

Compute the remainder x - y * n where n is the integer nearest to x/y (with ties broken to even values of n). Output is written into the final argument.

fsqrt :: BFOpts -> BF -> BF -> IO Status

Compute the square root of the first number and store the result in the second.

fpow :: BFOpts -> BF -> BF -> BF -> IO Status

Exponentiate the first number by the second, and store the result in the third number.

fround :: BFOpts -> BF -> IO Status

Round to the nearest float matching the configuration parameters.

frint :: RoundMode -> BF -> IO Status

Round to the neareset integer.

Convert from a number

toDouble :: RoundMode -> BF -> IO (Double, Status)

Get the current value of a BF as a Haskell Double.

toString :: Int -> ShowFmt -> BF -> IO String

Render a big-float as a Haskell string. The radix should not exceed maxRadix.

toRep :: BF -> IO BFRep

Get the representation of the number.

data BFRep

An explicit representation for big nums.

Constructors

BFRep !Sign !BFNum

A signed number

BFNaN

Not a number

Instances

Eq BFRep

Defined in LibBF.Mutable

Methods

(==) :: BFRep -> BFRep -> Bool

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

Ord BFRep

Defined in LibBF.Mutable

Methods

compare :: BFRep -> BFRep -> Ordering

(<) :: BFRep -> BFRep -> Bool

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

(>) :: BFRep -> BFRep -> Bool

(>=) :: BFRep -> BFRep -> Bool

max :: BFRep -> BFRep -> BFRep

min :: BFRep -> BFRep -> BFRep

Show BFRep

Defined in LibBF.Mutable

Methods

showsPrec :: Int -> BFRep -> ShowS

show :: BFRep -> String

showList :: [BFRep] -> ShowS

Hashable BFRep

Defined in LibBF.Mutable

Methods

hashWithSalt :: Int -> BFRep -> Int

hash :: BFRep -> Int

data BFNum

Representations for unsigned floating point numbers.

Constructors

Zero

zero

Num Integer !Int64

x * 2 ^ y

Inf

infinity

Instances

Eq BFNum

Defined in LibBF.Mutable

Methods

(==) :: BFNum -> BFNum -> Bool

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

Ord BFNum

Defined in LibBF.Mutable

Methods

compare :: BFNum -> BFNum -> Ordering

(<) :: BFNum -> BFNum -> Bool

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

(>) :: BFNum -> BFNum -> Bool

(>=) :: BFNum -> BFNum -> Bool

max :: BFNum -> BFNum -> BFNum

min :: BFNum -> BFNum -> BFNum

Show BFNum

Defined in LibBF.Mutable

Methods

showsPrec :: Int -> BFNum -> ShowS

show :: BFNum -> String

showList :: [BFNum] -> ShowS

Hashable BFNum

Defined in LibBF.Mutable

Methods

hashWithSalt :: Int -> BFNum -> Int

hash :: BFNum -> Int

Configuration

module LibBF.Opts

toChunks :: Integer -> [LimbT]

Chunk a non-negative integer into words, least significatn first