A library for computing with (but not reasoning about) Common Lisp floats from within ACL2.

ACL2 doesn't provide a floating point number representation or any operations for floating point arithmetic. So if you want to use floating point numbers in ACL2, what are your options?

One approach is to model floating-point numbers using some machine-like representation (e.g., as triples with a sign bit, some exponent bits, and some mantissa bits) and write ACL2 functions that carry out the desired FP operations on top of this representation. This is done in, for instance, the ACL2::rtl library. This approach is well-principled and has many advantages, e.g., it provides real logical definitions that can be reasoned about. But it is also a lot of work and, for instance, RTL is a relatively heavyweight library.

The **lispfloat** library takes a much less-principled but lighter-weight
approach. Our goal is not to try to specify how FP operations work, but merely
to try to provide a pragmatic way to compute with floats by connecting ACL2 to
the existing FP implementation provided by the Lisp environment. The main
issues here are how to represent floats in a convenient way for the ACL2
program (since real floats aren't valid ACL2 objects), and how to provide a
sound connection to the Lisp runtime.

To represent floats as ACL2 objects we just use rationals. This is quite imperfect. There are weird floats (infinities, nans) that don't even represent rationals, and positive/negative versions of zero that will both map to 0. There are also (of course) rationals that cannot be represented as floats without being rounded.

But in practice this is still pretty good. Any ``sensible'' float (e.g., normal, denormal, or the zeroes) can be turned into a rational and back without loss of precision. And any FP operation that doesn't do cause an exception will result in a sensible number. In short, if we start with sensible numbers and then only carry out reasonable FP operations on them, we should always stay in the realm of sensible numbers where using rationals works fine.

The floating point functions that we implement each take rationals as inputs and produce rationals as their results. These functions might be called on bad inputs such as (1) rational numbers that we cannot correctly turn into floats because they are too big or would require rounding, or (2) arguments that cause the underlying FP operation to encounter some exception like an overflow, divide by zero, or similar.

To identify these cases, each FP operation also returns a potential error
message, which is either a string that describes the problem or is

We do not provide logical definitions for our floating-point operations, but
instead introduce them with encapsulate and constrain them so that they
are known to produce sensible results (error messages are strings or

By themselves, these logical definitions are just an ordinary encapsulate and hence don't require any trust tags. You can load just these logical definitions by doing:

(include-book "centaur/lispfloat/ops-logic" :dir :system)

However, note that these operations can't be executed until you load the
executable versions, typically by including

We define executable versions of the operations as ``untouchable'' program-mode functions, which we then (using a trust-tag) redefine in raw Common Lisp and attach to the logical definitions.

Once this has been done, you can run these functions to carry out floating point computations. For example:

ACL2 !>(include-book "centaur/lispfloat/top" :dir :system) ACL2 !>(lispfloat::er-float+ 1/2 1/2) (nil 1) ;; no error, answer is 1

Note however that you will still not be able to prove anything about the
actual evaluations of these floating-point operations. For instance, trying to
prove a theorem like this will **fail**:

(thm (equal (mv-nth 1 (lispfloat::er-float+ 1/2 1/2)) 1))

We currently support single- and double-precision versions of the basic
arithmetic operations (+, -, *, /), exponentiation of

We don't yet implement many operations that are available in Common Lisp such as arcsine, log, etc., because they can return complex numbers for some inputs and we haven't decided how to handle that yet.

Other functions that are currently missing but would probably be mostly straightforward to add: basic inequality comparisons, round a float/double to the nearest integer, parse a string as a float/double (doesn't seem to be built into Common Lisp but there are Quicklisp libraries like parse-number), convert a float/double into a string, etc.

- Er-float+
- (Single-precision) floating point addition.
- Er-float-expt
- (Single-precision) floating point exponentiation.
- Er-double-expt
- (Double-precision) floating point exponentiation.
- Er-float/
- (Single-precision) floating point division.
- Er-float*
- (Single-precision) floating point multiplication.
- Er-float-
- (Single-precision) floating point subtraction.
- Er-double/
- (Double-precision) floating point division.
- Er-double+
- (Double-precision) floating point addition.
- Er-double*
- (Double-precision) floating point multiplication.
- Er-double-
- (Double-precision) floating point subtraction.
- Er-float-tan
- (Single-precision) floating point tangent.
- Er-float-sqrt
- (Single-precision) floating point square root.
- Er-float-sin
- (Single-precision) floating point sine.
- Er-float-e^x
- (Single-precision) floating point e^x.
- Er-float-cos
- (Single-precision) floating point cosine.
- Er-double-tan
- (Double-precision) floating point tangent.
- Er-double-sqrt
- (Double-precision) floating point square root.
- Er-double-sin
- (Double-precision) floating point sine.
- Er-double-e^x
- (Double-precision) floating point e^x.
- Er-double-cos
- (Double-precision) floating point cosine.