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

The extended-reals Reference Manual

This is the extended-reals Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:22:52 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The extended-reals Reference Manual, Up: The extended-reals Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The extended-reals Reference Manual [Contents][Index]

2 Systems

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

extended-reals

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

2.1 `extended-reals`

Extended real numbers for Common Lisp.

Author: Tamas K Papp <tkpapp@gmail.com>
License: Boost Software License - Version 1.0
Dependency: alexandria (system).
Source: extended-reals.asd.
Child Component: extended-reals.lisp (file).

Next: Packages, Previous: Systems, Up: The extended-reals 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 Lisp

extended-reals/extended-reals.asd
extended-reals/extended-reals.lisp

Next: extended-reals/extended-reals.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `extended-reals/extended-reals.asd`

Source: extended-reals.asd.
Parent Component: extended-reals (system).
ASDF Systems: extended-reals.

Previous: extended-reals/extended-reals.asd, Up: Lisp [Contents][Index]

3.1.2 `extended-reals/extended-reals.lisp`

Source

extended-reals.asd.

Parent Component

extended-reals (system).

Packages

extended-reals.

Public Interface

-inf (function).
-inf? (function).
< (function).
<= (function).
= (function).
> (function).
>= (function).
extended-real (type).
inf (function).
inf? (function).
infinite? (function).
lambda-template (macro).
with-template (macro).

Internals

define-pairwise (macro).
extend-pairwise-comparison (function).

Next: Definitions, Previous: Files, Up: The extended-reals Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

extended-reals

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

4.1 `extended-reals`

Source

extended-reals.lisp.

Nickname

xreal

Use List

alexandria.
common-lisp.

Public Interface

-inf (function).
-inf? (function).
< (function).
<= (function).
= (function).
> (function).
>= (function).
extended-real (type).
inf (function).
inf? (function).
infinite? (function).
lambda-template (macro).
with-template (macro).

Internals

define-pairwise (macro).
extend-pairwise-comparison (function).

Next: Indexes, Previous: Packages, Up: The extended-reals 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

Macros
Ordinary functions
Types

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: lambda-template ((prefix &rest variables) &body body) ¶

Package: extended-reals.
Source: extended-reals.lisp.

Macro: with-template ((prefix &rest variables) &body body) ¶

Package: extended-reals.
Source: extended-reals.lisp.

Next: Types, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: -inf () ¶

Return an object representing negative infinity.

Package: extended-reals.
Source: extended-reals.lisp.

Function: -inf? (object) ¶

Test if an object represents negative infinity.

Package: extended-reals.
Source: extended-reals.lisp.

Function: < (number &rest more-numbers) ¶

Package: extended-reals.
Source: extended-reals.lisp.

Function: <= (number &rest more-numbers) ¶

Package: extended-reals.
Source: extended-reals.lisp.

Function: = (number &rest more-numbers) ¶

Package: extended-reals.
Source: extended-reals.lisp.

Function: > (number &rest more-numbers) ¶

Package: extended-reals.
Source: extended-reals.lisp.

Function: >= (number &rest more-numbers) ¶

Package: extended-reals.
Source: extended-reals.lisp.

Function: inf () ¶

Return an object representing (positive) infinity.

Package: extended-reals.
Source: extended-reals.lisp.

Function: inf? (object) ¶

Test if an object represents (positive) infinity.

Package: extended-reals.
Source: extended-reals.lisp.

Function: infinite? (object) ¶

Test if an object represents positive or negative infinity.

Package: extended-reals.
Source: extended-reals.lisp.

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

5.1.3 Types

Type: extended-real (&optional base) ¶

Package: extended-reals.
Source: extended-reals.lisp.

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

5.2 Internals

Macros
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Macros

Macro: define-pairwise (name test) ¶

Package: extended-reals.
Source: extended-reals.lisp.

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

5.2.2 Ordinary functions

Function: extend-pairwise-comparison (test first rest) ¶

Package: extended-reals.
Source: extended-reals.lisp.

Previous: Definitions, Up: The extended-reals Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	- < = > D E F I L M W

	Index Entry		Section

-
	`-inf`:		Public ordinary functions
	`-inf?`:		Public ordinary functions

<
	`<`:		Public ordinary functions
	`<=`:		Public ordinary functions

=
	`=`:		Public ordinary functions

>
	`>`:		Public ordinary functions
	`>=`:		Public ordinary functions

D
	`define-pairwise`:		Private macros

E
	`extend-pairwise-comparison`:		Private ordinary functions

F
	`Function, -inf`:		Public ordinary functions
	`Function, -inf?`:		Public ordinary functions
	`Function, <`:		Public ordinary functions
	`Function, <=`:		Public ordinary functions
	`Function, =`:		Public ordinary functions
	`Function, >`:		Public ordinary functions
	`Function, >=`:		Public ordinary functions
	`Function, extend-pairwise-comparison`:		Private ordinary functions
	`Function, inf`:		Public ordinary functions
	`Function, inf?`:		Public ordinary functions
	`Function, infinite?`:		Public ordinary functions

I
	`inf`:		Public ordinary functions
	`inf?`:		Public ordinary functions
	`infinite?`:		Public ordinary functions

L
	`lambda-template`:		Public macros

M
	`Macro, define-pairwise`:		Private macros
	`Macro, lambda-template`:		Public macros
	`Macro, with-template`:		Public macros

W
	`with-template`:		Public macros

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

A.3 Variables

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

A.4 Data types

Jump to:	E F P S T

	Index Entry		Section

E
	`extended-real`:		Public types
	`extended-reals`:		The extended-reals system
	`extended-reals`:		The extended-reals package
	`extended-reals.asd`:		The extended-reals/extended-reals․asd file
	`extended-reals.lisp`:		The extended-reals/extended-reals․lisp file

F
	`File, extended-reals.asd`:		The extended-reals/extended-reals․asd file
	`File, extended-reals.lisp`:		The extended-reals/extended-reals․lisp file

P
	`Package, extended-reals`:		The extended-reals package

S
	`System, extended-reals`:		The extended-reals system

T
	`Type, extended-real`:		Public types