This is the float-features Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:25:56 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
float-featuresA portability library for IEEE float features not covered by the CL standard.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
zlib
1.0.0
trivial-features (system).
documentation-utils (system).
float-features.lisp (file).
documentation.lisp (file).
nan.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
float-features/float-features.asdfloat-features/float-features.lispfloat-features/documentation.lispfloat-features/nan.lispfloat-features/float-features.asdfloat-features (system).
float-features/float-features.lispfloat-features (system).
bits-double-float (function).
bits-long-float (function).
bits-short-float (function).
bits-single-float (function).
double-float-bits (function).
double-float-negative-infinity (constant).
double-float-positive-infinity (constant).
float-infinity-p (function).
float-nan-p (function).
long-float-bits (function).
long-float-negative-infinity (constant).
long-float-positive-infinity (constant).
short-float-bits (function).
short-float-negative-infinity (constant).
short-float-positive-infinity (constant).
single-float-bits (function).
single-float-negative-infinity (constant).
single-float-positive-infinity (constant).
with-float-traps-masked (macro).
with-rounding-mode (macro).
float-features/documentation.lispfloat-features.lisp (file).
float-features (system).
float-features/nan.lispdocumentation.lisp (file).
float-features (system).
double-float-nan (constant).
long-float-nan (symbol macro).
short-float-nan (constant).
single-float-nan (constant).
Packages are listed by definition order.
float-featuresorg.shirakumo.float-features
common-lisp.
bits-double-float (function).
bits-long-float (function).
bits-short-float (function).
bits-single-float (function).
double-float-bits (function).
double-float-nan (constant).
double-float-negative-infinity (constant).
double-float-positive-infinity (constant).
float-infinity-p (function).
float-nan-p (function).
long-float-bits (function).
long-float-nan (symbol macro).
long-float-negative-infinity (constant).
long-float-positive-infinity (constant).
short-float-bits (function).
short-float-nan (constant).
short-float-negative-infinity (constant).
short-float-positive-infinity (constant).
single-float-bits (function).
single-float-nan (constant).
single-float-negative-infinity (constant).
single-float-positive-infinity (constant).
with-float-traps-masked (macro).
with-rounding-mode (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A positive quiet NaN value with zero-cleared payload for double-floats.
This value should NOT be used for comparison with a float value for the pupose of testing NaN
because NaN has unused bits (called payload) which are explicitly allowed to store additional information.
Comparing this value with other NaN representations via = will fail.
To test if a number is a NaN, use FLOAT-NAN-P.
It is supported on implementations which support BITS-DOUBLE-FLOAT.
Defaults to MOST-POSITIVE-DOUBLE-FLOAT on unsupported implementations.
The negative infinity for double-floats.
Supported on:
* ABCL
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* MKCL
* SBCL
Defaults to MOST-NEGATIVE-DOUBLE-FLOAT on unsupported implementations.
The positive infinity for double-floats.
Supported on:
* ABCL
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* MKCL
* SBCL
Defaults to MOST-POSITIVE-DOUBLE-FLOAT on unsupported implementations.
The negative infinity for long-floats.
Supported on:
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* MKCL
* SBCL
Defaults to MOST-NEGATIVE-LONG-FLOAT on unsupported implementations.
The positive infinity for long-floats.
Supported on:
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* MKCL
* SBCL
Defaults to MOST-POSITIVE-LONG-FLOAT on unsupported implementations.
A positive quiet NaN value with zero-cleared payload for short-floats.
This value should NOT be used for comparison with a float value for the pupose of testing NaN
because NaN has unused bits (called payload) which are explicitly allowed to store additional information.
Comparing this value with other NaN representations via = will fail.
To test if a number is a NaN, use FLOAT-NAN-P.
It is supported on implementations which support BITS-SHORT-FLOAT.
Defaults to MOST-POSITIVE-SHORT-FLOAT on unsupported implementations.
The negative infinity for short-floats.
Supported on:
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* MKCL
* SBCL
Defaults to MOST-NEGATIVE-SHORT-FLOAT on unsupported implementations.
The positive infinity for short-floats.
Supported on:
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* MKCL
* SBCL
Defaults to MOST-POSITIVE-SHORT-FLOAT on unsupported implementations.
A positive quiet NaN value with zero-cleared payload for single-floats.
This value should NOT be used for comparison with a float value for the pupose of testing NaN
because NaN has unused bits (called payload) which are explicitly allowed to store additional information.
Comparing this value with other NaN representations via = will fail.
To test if a number is a NaN, use FLOAT-NAN-P.
It is supported on implementations which support BITS-SINGLE-FLOAT.
Defaults to MOST-POSITIVE-SINGLE-FLOAT on unsupported implementations.
The negative infinity for single-floats.
Supported on:
* ABCL
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* MKCL
* SBCL
Defaults to MOST-NEGATIVE-SINGLE-FLOAT on unsupported implementations.
The positive infinity for single-floats.
Supported on:
* ABCL
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* MKCL
* SBCL
Defaults to MOST-POSITIVE-SINGLE-FLOAT on unsupported implementations.
Attempts to mask the given floating point traps.
Masking a floating point trap causes the given floating point exception
to not signal a condition in the lisp world, and instead lets the
operation return a float that is either a NaN or an infinity.
The following traps are recognised:
:underflow
:overflow
:inexact
:invalid
:divide-by-zero
:denormalized-operand
The traps argument may be either a list of the above trap identifiers,
or T to signify all maskable traps.
Note that not all implementations will signal conditions on all of the
above floating point traps anyway, and some implementations may only
support masking some of the above traps.
Supported on:
* ABCL (:overflow :underflow)
* CCL (:overflow :underflow :inexact :invalid :divide-by-zero)
* CLISP (:underflow)
* CMUCL T
* ECL (:underflow :overflow :inexact :invalid :divide-by-zero)
* MEZZANO T
* SBCL T
Defaults to a progn on unsupported implementations and ignores unsupported traps.
Encodes the (unsigned-byte 64) bit representation into a native double-float.
Supported on:
* ABCL
* ALLEGRO
* CCL
* CLASP
* CMUCL
* LISPWORKS
* MEZZANO
* SBCL
Defaults to signalling an error on unsupported implementations.
Encodes the (unsigned-byte 128) bit representation into a native long-float.
Supported on:
Defaults to signalling an error on unsupported implementations.
Encodes the (unsigned-byte 16) bit representation into a native short-float.
Supported on:
* MEZZANO
Supported (with 32bit short-float = single-float) on:
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS (64-bit only. on 32-bit lw, short-float is not 16 or 32 bits)
* SBCL
Defaults to signalling an error on unsupported implementations.
Encodes the (unsigned-byte 32) bit representation into a native single-float.
Supported on:
* ABCL
* ALLEGRO
* CCL
* CLASP
* CMUCL
* LISPWORKS
* MEZZANO
* SBCL
Defaults to signalling an error on unsupported implementations.
Returns the bit representation of the double-float as an (unsigned-byte 64).
Supported on:
* ABCL
* ALLEGRO
* CCL
* CLASP
* CMUCL
* LISPWORKS
* MEZZANO
* SBCL
Defaults to signalling an error on unsupported implementations.
Returns T if the given float is an infinity, NIL otherwise.
Supported on:
* ABCL
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* SBCL
Defaults to comparing against the individual constants on unsupported implementations.
Returns T if the given float is in not-a-number state, NIL otherwise.
Supported on:
* ABCL
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS
* MEZZANO
* SBCL
Defaults to returning NIL on unsupported implementations.
Returns the bit representation of the long-float as an (unsigned-byte 128).
Supported on:
Defaults to signalling an error on unsupported implementations.
Returns the bit representation of the short-float as an (unsigned-byte 16).
Supported on:
* MEZZANO
Supported (with 32bit short-float = single-float) on:
* ALLEGRO
* CCL
* CMUCL
* ECL
* LISPWORKS (64-bit only. on 32-bit lw, short-float is not 16 or 32 bits)
* SBCL
On platforms with 32-bit short-float, low bits of significand are
dropped without rounding, and out of range exponents are converted to
infinities. All values returned by bits-short-float should convert
back to the same bits.
Defaults to signalling an error on unsupported implementations.
Returns the bit representation of the single-float as an (unsigned-byte 32).
Supported on:
* ABCL
* ALLEGRO
* CCL
* CLASP
* CMUCL
* LISPWORKS
* MEZZANO
* SBCL
Defaults to signalling an error on unsupported implementations.
Temporarily set rounding mode when execute body.
The following modes are recognised:
:nearest Round to nearest, ties to even
:positive Round toward positive infinity
:negative Round toward negative infinity
:zero Round toward zero
Note that many compilers would by default try to fold floating point
expressions into constants before the rounding mode can take effect.
It is advisory to check disassembled functions to see if that is the
case when the result is not expected.
Supported on:
* CCL
* CMUCL
* MEZZANO
* SBCL
Defaults to a progn on unsupported implementations.
| Jump to: | B D F L M S W |
|---|
| Jump to: | B D F L M S W |
|---|
| Jump to: | C D L S |
|---|
| Jump to: | C D L S |
|---|
| Jump to: | D F N P S |
|---|
| Jump to: | D F N P S |
|---|