Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The floating-point-contractions Reference Manual

This is the floating-point-contractions Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 06:03:46 2023 GMT+0.

Next: Systems, Previous: The floating-point-contractions Reference Manual, Up: The floating-point-contractions Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The floating-point-contractions Reference Manual [Contents][Index]

2 Systems

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

floating-point-contractions

Previous: Systems, Up: Systems [Contents][Index]

2.1 `floating-point-contractions`

Numerically stable contractions of floating-point operations.

Author

Paul M. Rodriguez <pmr@ruricolist.com>

License

MIT

Source

floating-point-contractions.asd.

Child Components

package.lisp (file).
floating-point-contractions.lisp (file).

Next: Packages, Previous: Systems, Up: The floating-point-contractions Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1.3 `floating-point-contractions/floating-point-contractions.lisp`

Dependency

package.lisp (file).

Source

floating-point-contractions.asd.

Parent Component

floating-point-contractions (system).

Public Interface

exp-1 (function).
exp-1/x (function).
expt-1 (function).
hypot (function).
lb (function).
lg (function).
ln (function).
log1+ (function).
log1+/x (function).
log1+exp (function).
log1- (function).
log1-exp (function).
log2-exp (function).
logexp-1 (function).

Internals

sq (function).

Next: Definitions, Previous: Files, Up: The floating-point-contractions Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

floating-point-contractions

Previous: Packages, Up: Packages [Contents][Index]

4.1 `floating-point-contractions`

Source

package.lisp.

Use List

common-lisp.

Public Interface

exp-1 (function).
exp-1/x (function).
expt-1 (function).
hypot (function).
lb (function).
lg (function).
ln (function).
log1+ (function).
log1+/x (function).
log1+exp (function).
log1- (function).
log1-exp (function).
log2-exp (function).
logexp-1 (function).

Internals

sq (function).

Next: Indexes, Previous: Packages, Up: The floating-point-contractions Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: exp-1 (x) ¶

Compute (- (exp x) 1) stably even when X is near zero.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: exp-1/x (x) ¶

Compute (/ (- (exp x) 1) x) stably even when X is near zero.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: expt-1 (a z) ¶

Compute (a^z)-1 stably even when A is close to 1 or Z is close to zero.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: hypot (x y) ¶

Compute the hypotenuse of X and Y without danger of floating-point overflow or underflow.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: lb (n) ¶

Binary logarithm.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: lg (n) ¶

Decimal logarithm.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: ln (n) ¶

Natural logarithm.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: log1+ (x) ¶

Compute (log (+ 1 x)) stably even when X is near zero.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: log1+/x (x) ¶

Compute (/ (log (+ 1 x)) x) stably even when X is near zero.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: log1+exp (a) ¶

Accurately compute log(1+exp(x)) even when A is near zero.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: log1- (x) ¶

Compute (log (- 1 x)) stably even when X is near zero.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: log1-exp (a) ¶

Compute log(1-exp(x)) stably even when A is near zero.

This is sometimes known as the E_3, the third Einstein function.

See Mächler 2008 for notes on accurate calculation.

https://cran.r-project.org/web/packages/Rmpfr/vignettes/log1mexp-note.pdf

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: log2-exp (x) ¶

Compute log(2-exp(x)) stably even when X is near zero.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Function: logexp-1 (a) ¶

Compute log(exp(a)-1) stably even when A is small.

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Ordinary functions

Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Ordinary functions

Function: sq (x) ¶

Package: floating-point-contractions.
Source: floating-point-contractions.lisp.

Previous: Definitions, Up: The floating-point-contractions Reference Manual [Contents][Index]

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	E F H L S

	Index Entry	Section

E
	`exp-1`:	Public ordinary functions
	`exp-1/x`:	Public ordinary functions
	`expt-1`:	Public ordinary functions

F
	`Function, exp-1`:	Public ordinary functions
	`Function, exp-1/x`:	Public ordinary functions
	`Function, expt-1`:	Public ordinary functions
	`Function, hypot`:	Public ordinary functions
	`Function, lb`:	Public ordinary functions
	`Function, lg`:	Public ordinary functions
	`Function, ln`:	Public ordinary functions
	`Function, log1+`:	Public ordinary functions
	`Function, log1+/x`:	Public ordinary functions
	`Function, log1+exp`:	Public ordinary functions
	`Function, log1-`:	Public ordinary functions
	`Function, log1-exp`:	Public ordinary functions
	`Function, log2-exp`:	Public ordinary functions
	`Function, logexp-1`:	Public ordinary functions
	`Function, sq`:	Private ordinary functions

H
	`hypot`:	Public ordinary functions

L
	`lb`:	Public ordinary functions
	`lg`:	Public ordinary functions
	`ln`:	Public ordinary functions
	`log1+`:	Public ordinary functions
	`log1+/x`:	Public ordinary functions
	`log1+exp`:	Public ordinary functions
	`log1-`:	Public ordinary functions
	`log1-exp`:	Public ordinary functions
	`log2-exp`:	Public ordinary functions
	`logexp-1`:	Public ordinary functions

S
	`sq`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	F P S

	Index Entry	Section

F
	`File, floating-point-contractions.asd`:	The floating-point-contractions/floating-point-contractions․asd file
	`File, floating-point-contractions.lisp`:	The floating-point-contractions/floating-point-contractions․lisp file
	`File, package.lisp`:	The floating-point-contractions/package․lisp file
	`floating-point-contractions`:	The floating-point-contractions system
	`floating-point-contractions`:	The floating-point-contractions package
	`floating-point-contractions.asd`:	The floating-point-contractions/floating-point-contractions․asd file
	`floating-point-contractions.lisp`:	The floating-point-contractions/floating-point-contractions․lisp file

P
	`Package, floating-point-contractions`:	The floating-point-contractions package
	`package.lisp`:	The floating-point-contractions/package․lisp file

S
	`System, floating-point-contractions`:	The floating-point-contractions system

The floating-point-contractions Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 floating-point-contractions

3 Files

3.1 Lisp

3.1.1 floating-point-contractions/floating-point-contractions.asd

3.1.2 floating-point-contractions/package.lisp

3.1.3 floating-point-contractions/floating-point-contractions.lisp

4 Packages

4.1 floating-point-contractions

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `floating-point-contractions`

3.1.1 `floating-point-contractions/floating-point-contractions.asd`

3.1.2 `floating-point-contractions/package.lisp`

3.1.3 `floating-point-contractions/floating-point-contractions.lisp`

4.1 `floating-point-contractions`