The wu-decimal Reference Manual

Table of Contents

The wu-decimal Reference Manual

This is the wu-decimal Reference Manual, version 2.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 13:06:42 2021 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 wu-decimal

Author

Wukix Inc <engineering@wukix.com>

License

FreeBSD

Description

Arbitrary-precision decimal arithmetic

Long Description

Wu-Decimal enables convenient, arbitrary-precision decimal arithmetic through a reader macro, #$, and an update to the pprint dispatch table. Wu-Decimal uses the CL ratio type to store decimals, which enables numeric functions such as +, -, etc. to operate on decimal numbers in a natural way.

Version

2.0.0

Source

wu-decimal.asd (file)

Component

wu-decimal.lisp (file)

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

2.1 Lisp

2.1.1 wu-decimal.asd

Location

wu-decimal.asd

Systems

wu-decimal (system)

Packages

wu-decimal-asd

2.1.2 wu-decimal/wu-decimal.lisp

Parent

wu-decimal (system)

Location

wu-decimal.lisp

Packages

wu-decimal

Exported Definitions

• $ (function)
• *print-decimal-mark* (special variable)
• *print-precision-loss* (special variable)
• decimal (type)
• disable-decimal-printing-for-ratios (function)
• enable-decimal-printing-for-ratios (function)
• enable-reader-macro (function)
• f (function)
• parse-decimal (function)

Internal Definitions

• count-digits (function)
• decimal-for-pprint (type)
• decimal-reader (function)
• decimal-reader-exponent-allowed (function)
• decimal-to-digits (function)
• decimal-to-string (function)
• disallowed-loss-of-precision (condition)
• factor-out-powers-of-5 (function)
• find-multiplier (function)
• format-fixed-aux (function)
• has-finite-decimal-digits (function)
• incompatible-exponent-allowed-error (condition)
• incompatible-mark-and-separator-error (condition)
• integer-to-digit-string (function)
• is-power-of-2 (function)
• out-of-bounds-error (condition)
• whitespace-1-p (function)

3 Packages

Packages are listed by definition order.

3.1 wu-decimal-asd

Source

wu-decimal.asd

Use List

• common-lisp
• asdf/interface

3.2 wu-decimal

Source

wu-decimal.lisp (file)

Use List

common-lisp

Exported Definitions

• $ (function)
• *print-decimal-mark* (special variable)
• *print-precision-loss* (special variable)
• decimal (type)
• disable-decimal-printing-for-ratios (function)
• enable-decimal-printing-for-ratios (function)
• enable-reader-macro (function)
• f (function)
• parse-decimal (function)

Internal Definitions

• count-digits (function)
• decimal-for-pprint (type)
• decimal-reader (function)
• decimal-reader-exponent-allowed (function)
• decimal-to-digits (function)
• decimal-to-string (function)
• disallowed-loss-of-precision (condition)
• factor-out-powers-of-5 (function)
• find-multiplier (function)
• format-fixed-aux (function)
• has-finite-decimal-digits (function)
• incompatible-exponent-allowed-error (condition)
• incompatible-mark-and-separator-error (condition)
• integer-to-digit-string (function)
• is-power-of-2 (function)
• out-of-bounds-error (condition)
• whitespace-1-p (function)

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *print-decimal-mark*

Package

wu-decimal

Source

wu-decimal.lisp (file)

Special Variable: *print-precision-loss*

Precision loss mode. Must be :error, :round, or :truncate

Package

wu-decimal

Source

wu-decimal.lisp (file)

4.1.2 Functions

Function: $ STREAM DECIMAL COLON ATSIGN &optional D N W PAD

e.g. (format t "~/wu-decimal:$/" #$3.14)

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: disable-decimal-printing-for-ratios ()

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: enable-decimal-printing-for-ratios ()

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: enable-reader-macro &key EXPONENT-ALLOWED

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: f STREAM NUMBER COLON ATSIGN &optional W D K OVF PAD

e.g. (format t "~/wu-decimal:F/" #$3.14)

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: parse-decimal STRING &key START END SIGN-ALLOWED DECIMAL-MARK GROUP-SEPARATOR EXPONENT-ALLOWED JUNK-ALLOWED

PARSE-DECIMAL parses a decimal number from the substring of STRING delimited by START and END. Optional leading and trailing whitespace[1] is ignored. The character parameters DECIMAL-MARK and GROUP-SEPARATOR provide support for different (typically cultural) numerical conventions. For convenience, a GROUP-SEPARATOR of T will be treated as the comma character. The boolean SIGN-ALLOWED controls signage. EXPONENT-ALLOWED is a boolean or a sequence controlling exponent notation. Exponent notation follows the syntax for CL floats, with exception that the exponent marker must be ’e’ or ’E’ when EXPONENT-ALLOWED is T, or the exponent marker must be CHAR= to some element of EXPONENT-ALLOWED when EXPONENT-ALLOWED is a
sequence. JUNK-ALLOWED behaves as it does in PARSE-INTEGER. PARSE-DECIMAL returns two values: the parsed number of type DECIMAL, followed by the index of STRING where the parse terminated.
Example: (parse-decimal "1,205.42" :group-separator #\,) => 60271/50, 8

Package

wu-decimal

Source

wu-decimal.lisp (file)

4.1.3 Types

Type: decimal ()

Package

wu-decimal

Source

wu-decimal.lisp (file)

4.2 Internal definitions

4.2.1 Functions

Function: count-digits INTEGER

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: decimal-reader STREAM SUBCHAR ARG

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: decimal-reader-exponent-allowed STREAM SUBCHAR ARG

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: decimal-to-digits NUMBER &optional POSITION RELATIVEP

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: decimal-to-string X &optional WIDTH FDIGITS SCALE FMIN

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: factor-out-powers-of-5 NUMBR

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: find-multiplier D

Given an integer, d, of the form 2^m*5^n, compute c such that c*d = c*(2^m*5^n) = 10^max(m,n). Returns c and max(m,n). See http://wukix.com/lisp-decimals#theory for background.

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: format-fixed-aux STREAM NUMBER W D K OVF PAD ATSIGN

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: has-finite-decimal-digits NUMBER

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: integer-to-digit-string INTEGER

Converts an integer into a base 10 string. The sign is ignored.

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: is-power-of-2 NUMBER

Package

wu-decimal

Source

wu-decimal.lisp (file)

Function: whitespace-1-p A-CHAR

Package

wu-decimal

Source

wu-decimal.lisp (file)

4.2.2 Conditions

Condition: disallowed-loss-of-precision ()

Package

wu-decimal

Source

wu-decimal.lisp (file)

Direct superclasses

condition (condition)

Condition: incompatible-exponent-allowed-error ()

Package

wu-decimal

Source

wu-decimal.lisp (file)

Direct superclasses

condition (condition)

Condition: incompatible-mark-and-separator-error ()

Package

wu-decimal

Source

wu-decimal.lisp (file)

Direct superclasses

condition (condition)

Condition: out-of-bounds-error ()

Package

wu-decimal

Source

wu-decimal.lisp (file)

Direct superclasses

condition (condition)

4.2.3 Types

Type: decimal-for-pprint ()

Package

wu-decimal

Source

wu-decimal.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types