The wu-decimal Reference Manual

This is the wu-decimal Reference Manual, version 2.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 06:32:35 2022 GMT+0.

1 Systems

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

wu-decimal

1.1 `wu-decimal`

Arbitrary-precision decimal arithmetic

Author: Wukix Inc <engineering@wukix.com>
License: FreeBSD
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.
Child Component: wu-decimal.lisp (file).

2 Files

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

Lisp

2.1.1 `wu-decimal/wu-decimal.asd`

Source: wu-decimal.asd.
Parent Component: wu-decimal (system).
ASDF Systems: wu-decimal.
Packages: wu-decimal-asd.

2.1.2 `wu-decimal/wu-decimal.lisp`

Source

wu-decimal.asd.

Parent Component

wu-decimal (system).

Packages

wu-decimal.

Public Interface

$ (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).

Internals

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.

wu-decimal-asd
wu-decimal

3.1 `wu-decimal-asd`

Source

wu-decimal.asd.

Use List

asdf/interface.
common-lisp.

3.2 `wu-decimal`

Source

wu-decimal.lisp.

Use List

common-lisp.

Public Interface

$ (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).

Internals

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.

Public Interface
Internals

4.1 Public Interface

Special variables
Ordinary functions
Types

4.1.1 Special variables

Special Variable: *print-decimal-mark* ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

Special Variable: *print-precision-loss* ¶

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

Package: wu-decimal.
Source: wu-decimal.lisp.

4.1.2 Ordinary 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.

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

Package: wu-decimal.
Source: wu-decimal.lisp.

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

Package: wu-decimal.
Source: wu-decimal.lisp.

Function: enable-reader-macro (&key exponent-allowed) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

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.

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.

4.1.3 Types

Type: decimal () ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

4.2 Internals

Ordinary functions
Conditions
Types

4.2.1 Ordinary functions

Function: count-digits (integer) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

Function: decimal-reader (stream subchar arg) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

Function: decimal-reader-exponent-allowed (stream subchar arg) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

Function: decimal-to-digits (number &optional position relativep) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

Function: decimal-to-string (x &optional width fdigits scale fmin) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

Function: factor-out-powers-of-5 (numbr) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

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.

Function: format-fixed-aux (stream number w d k ovf pad atsign) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

Function: has-finite-decimal-digits (number) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

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.

Function: is-power-of-2 (number) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

Function: whitespace-1-p (a-char) ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

4.2.2 Conditions

Condition: disallowed-loss-of-precision ¶

Package: wu-decimal.
Source: wu-decimal.lisp.
Direct superclasses: condition.

Condition: incompatible-exponent-allowed-error ¶

Package: wu-decimal.
Source: wu-decimal.lisp.
Direct superclasses: condition.

Condition: incompatible-mark-and-separator-error ¶

Package: wu-decimal.
Source: wu-decimal.lisp.
Direct superclasses: condition.

Condition: out-of-bounds-error ¶

Package: wu-decimal.
Source: wu-decimal.lisp.
Direct superclasses: condition.

4.2.3 Types

Type: decimal-for-pprint () ¶

Package: wu-decimal.
Source: wu-decimal.lisp.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	$ C D E F H I P W

	Index Entry	Section

$
	`$`:	Public ordinary functions

C
	`count-digits`:	Private ordinary functions

D
	`decimal-reader`:	Private ordinary functions
	`decimal-reader-exponent-allowed`:	Private ordinary functions
	`decimal-to-digits`:	Private ordinary functions
	`decimal-to-string`:	Private ordinary functions
	`disable-decimal-printing-for-ratios`:	Public ordinary functions

E
	`enable-decimal-printing-for-ratios`:	Public ordinary functions
	`enable-reader-macro`:	Public ordinary functions

F
	`f`:	Public ordinary functions
	`factor-out-powers-of-5`:	Private ordinary functions
	`find-multiplier`:	Private ordinary functions
	`format-fixed-aux`:	Private ordinary functions
	`Function, $`:	Public ordinary functions
	`Function, count-digits`:	Private ordinary functions
	`Function, decimal-reader`:	Private ordinary functions
	`Function, decimal-reader-exponent-allowed`:	Private ordinary functions
	`Function, decimal-to-digits`:	Private ordinary functions
	`Function, decimal-to-string`:	Private ordinary functions
	`Function, disable-decimal-printing-for-ratios`:	Public ordinary functions
	`Function, enable-decimal-printing-for-ratios`:	Public ordinary functions
	`Function, enable-reader-macro`:	Public ordinary functions
	`Function, f`:	Public ordinary functions
	`Function, factor-out-powers-of-5`:	Private ordinary functions
	`Function, find-multiplier`:	Private ordinary functions
	`Function, format-fixed-aux`:	Private ordinary functions
	`Function, has-finite-decimal-digits`:	Private ordinary functions
	`Function, integer-to-digit-string`:	Private ordinary functions
	`Function, is-power-of-2`:	Private ordinary functions
	`Function, parse-decimal`:	Public ordinary functions
	`Function, whitespace-1-p`:	Private ordinary functions

H
	`has-finite-decimal-digits`:	Private ordinary functions

I
	`integer-to-digit-string`:	Private ordinary functions
	`is-power-of-2`:	Private ordinary functions

P
	`parse-decimal`:	Public ordinary functions

W
	`whitespace-1-p`:	Private ordinary functions

Jump to:	$ C D E F H I P W

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`print-decimal-mark`:	Public special variables
	`print-precision-loss`:	Public special variables

S
	`Special Variable, print-decimal-mark`:	Public special variables
	`Special Variable, print-precision-loss`:	Public special variables

Jump to:	* S

A.4 Data types

Jump to:	C D F I O P S T W

	Index Entry	Section

C
	`Condition, disallowed-loss-of-precision`:	Private conditions
	`Condition, incompatible-exponent-allowed-error`:	Private conditions
	`Condition, incompatible-mark-and-separator-error`:	Private conditions
	`Condition, out-of-bounds-error`:	Private conditions

D
	`decimal`:	Public types
	`decimal-for-pprint`:	Private types
	`disallowed-loss-of-precision`:	Private conditions

F
	`File, wu-decimal.asd`:	The wu-decimal/wu-decimal․asd file
	`File, wu-decimal.lisp`:	The wu-decimal/wu-decimal․lisp file

I
	`incompatible-exponent-allowed-error`:	Private conditions
	`incompatible-mark-and-separator-error`:	Private conditions

O
	`out-of-bounds-error`:	Private conditions

P
	`Package, wu-decimal`:	The wu-decimal package
	`Package, wu-decimal-asd`:	The wu-decimal-asd package

S
	`System, wu-decimal`:	The wu-decimal system

T
	`Type, decimal`:	Public types
	`Type, decimal-for-pprint`:	Private types

W
	`wu-decimal`:	The wu-decimal system
	`wu-decimal`:	The wu-decimal package
	`wu-decimal-asd`:	The wu-decimal-asd package
	`wu-decimal.asd`:	The wu-decimal/wu-decimal․asd file
	`wu-decimal.lisp`:	The wu-decimal/wu-decimal․lisp file

Jump to:	C D F I O P S T W

The wu-decimal Reference Manual

The wu-decimal Reference Manual

Table of Contents

1 Systems

1.1 wu-decimal

2 Files

2.1 Lisp

2.1.1 wu-decimal/wu-decimal.asd

2.1.2 wu-decimal/wu-decimal.lisp

3 Packages

3.1 wu-decimal-asd

3.2 wu-decimal

4 Definitions

4.1 Public Interface

4.1.1 Special variables

4.1.2 Ordinary functions

4.1.3 Types

4.2 Internals

4.2.1 Ordinary functions

4.2.2 Conditions

4.2.3 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `wu-decimal`

2.1.1 `wu-decimal/wu-decimal.asd`

2.1.2 `wu-decimal/wu-decimal.lisp`

3.1 `wu-decimal-asd`

3.2 `wu-decimal`