Documentation.SBV.Examples.Misc.Floating

Several examples involving IEEE-754 floating point numbers, i.e., single precision Float (SFloat), double precision Double (SDouble), and the generic SFloatingPoint eb sb type where the user can specify the exponent and significand bit-widths. (Note that there is always an extra sign-bit, and the value of sb includes the hidden bit.)

Arithmetic with floating point is full of surprises; due to precision issues associativity of arithmetic operations typically do not hold. Also, the presence of NaN is always something to look out for.

Documentation

>>> -- For doctest purposes only:
>>> import Data.SBV

FP addition is not associative

assocPlus :: SFloat -> SFloat -> SFloat -> SBool

Prove that floating point addition is not associative. For illustration purposes, we will require one of the inputs to be a NaN. We have:

>>> prove $ assocPlus (0/0)
Falsifiable. Counter-example:
  s0 = 0.0 :: Float
  s1 = 0.0 :: Float

Indeed:

>>> let i = 0/0 :: Float
>>> i + (0.0 + 0.0)
NaN
>>> ((i + 0.0) + 0.0)
NaN

But keep in mind that NaN does not equal itself in the floating point world! We have:

>>> let nan = 0/0 :: Float in nan == nan
False

assocPlusRegular :: IO ThmResult

Prove that addition is not associative, even if we ignore NaN/Infinity values. To do this, we use the predicate fpIsPoint, which is true of a floating point number (SFloat or SDouble) if it is neither NaN nor Infinity. (That is, it's a representable point in the real-number line.)

We have:

>>> assocPlusRegular
Falsifiable. Counter-example:
  x = -3.0359216e35 :: Float
  y =   5.058223e30 :: Float
  z =   8.307169e34 :: Float

Indeed, we have:

>>> let x = -3.0359216e35 :: Float
>>> let y =   5.058223e30 :: Float
>>> let z =   8.307169e34 :: Float
>>> x + (y + z)
-2.205154e35
>>> (x + y) + z
-2.2051543e35

Note the difference in the results!

FP addition by non-zero can result in no change

nonZeroAddition :: IO ThmResult

Demonstrate that a+b = a does not necessarily mean b is 0 in the floating point world, even when we disallow the obvious solution when a and b are Infinity. We have:

>>> nonZeroAddition
Falsifiable. Counter-example:
  a = 2.5068128e37 :: Float
  b =    -5.354632 :: Float

Indeed, we have:

>>> let a = 2.5068128e37 :: Float
>>> let b =    -5.354632 :: Float
>>> a + b == a
True
>>> b == 0
False

FP multiplicative inverses may not exist

multInverse :: IO ThmResult

This example illustrates that a * (1/a) does not necessarily equal 1. Again, we protect against division by 0 and NaN/Infinity.

We have:

>>> multInverse
Falsifiable. Counter-example:
  a = 1.2760589e38 :: Float

Indeed, we have:

>>> let a = 1.2760589e38 :: Float
>>> a * (1/a)
0.99999994

Effect of rounding modes

roundingAdd :: IO SatResult

One interesting aspect of floating-point is that the chosen rounding-mode can effect the results of a computation if the exact result cannot be precisely represented. SBV exports the functions fpAdd, fpSub, fpMul, fpDiv, fpFMA and fpSqrt which allows users to specify the IEEE supported RoundingMode for the operation. This example illustrates how SBV can be used to find rounding-modes where, for instance, addition can produce different results. We have:

>>> roundingAdd
Satisfiable. Model:
  rm = RoundTowardNegative :: RoundingMode
  x  =       3.2806003e-21 :: Float
  y  =       -5.749071e-20 :: Float

(Note that depending on your version of Z3, you might get a different result.) Unfortunately Haskell floats do not allow computation with arbitrary rounding modes, but SBV's SFloatingPoint type does. We have:

>>> fpAdd sRoundNearestTiesToEven 3.2806003e-21 (-5.749071e-20) :: SFPSingle
-5.42101054e-20 :: SFloatingPoint 8 24
>>> fpAdd sRoundTowardNegative 3.2806003e-21 (-5.749071e-20) :: SFPSingle
-5.42101086e-20 :: SFloatingPoint 8 24

We can see why these two results are indeed different: The RoundTowardNegative (which rounds towards negative infinity from zero) produces a smaller result. Indeed, if we treat these numbers as Double values, we get:

>>> 3.2806003e-21 + (-5.749071e-20) :: Double
-5.42101097e-20

we see that the "more precise" result is smaller than what the Float value is, justifying the smaller value with RoundTowardNegative. A more detailed study is beyond our current scope, so we'll merely note that floating point representation and semantics is indeed a thorny subject, and point to http://ece.uwaterloo.ca/~dwharder/NumericalAnalysis/02Numerics/Double/paper.pdf as an excellent guide.

fp54Bounds :: IO OptimizeResult

Arbitrary precision floating-point numbers. SBV can talk about floating point numbers with arbitrary exponent and significand sizes as well. Here is a simple example demonstrating the minimum non-zero positive and maximum floating point values with exponent width 5 and significand width 4, which is actually 3 bits for the significand explicitly stored, includes the hidden bit. We have:

>>> fp54Bounds
Objective "max": Optimal model:
  x   = 61400 :: FloatingPoint 5 4
  max =   503 :: WordN 9
  min =   503 :: WordN 9
Objective "min": Optimal model:
  x   = 0.00000763 :: FloatingPoint 5 4
  max =        257 :: WordN 9
  min =        257 :: WordN 9

The careful reader will notice that the numbers 61400 and 0.00000763 are quite suspicious, but the metric space equivalents are correct. The reason for this is due to the sparcity of floats. The "computed" value of the maximum in this bound is actually 61440, however in FloatingPoint 5 4 representation all numbers between 57344 and 61440 collapse to the same bit-pattern, and the pretty-printer picks a string representation in decimal that falls within range that it considers is the "simplest." (Printing floats precisely is a thorny subject!) Likewise, the minimum value we're looking for is actually 2^-17, but any number between 2^-16 and 2^-17 will map to this number. It turns out that 0.00000763 in decimal is one such value. Moral of the story is that when reading floating-point numbers in decimal notation one should be very careful about the printed representation and the numeric value; while they will match in vsalue (if there are no bugs!), they can print quite differently! (Also keep in mind the rounding modes that impact how the conversion is done.)