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

The zsort Reference Manual

This is the zsort Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:20:29 2024 GMT+0.

Next: Systems, Previous: The zsort Reference Manual, Up: The zsort Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The zsort Reference Manual [Contents][Index]

2 Systems

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

zsort

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

2.1 `zsort`

zsort is a collection of portable sorting algorithms.

Author

Jorge Tavares <jorge.tavares@ieee.org>

License

MIT

Version

0.1

Dependency

alexandria (system).

Source

zsort.asd.

Child Components

packages.lisp (file).
base.lisp (file).
insertion-sort.lisp (file).
quicksort.lisp (file).
merge-sort.lisp (file).
heapsort.lisp (file).
counting-sort.lisp (file).
readme (file).
license (file).

Next: Packages, Previous: Systems, Up: The zsort Reference Manual [Contents][Index]

3 Files

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

Lisp
Static

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

Next: zsort/packages.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `zsort/zsort.asd`

Source: zsort.asd.
Parent Component: zsort (system).
ASDF Systems: zsort.

Next: zsort/base.lisp, Previous: zsort/zsort.asd, Up: Lisp [Contents][Index]

3.1.2 `zsort/packages.lisp`

Source: zsort.asd.
Parent Component: zsort (system).
Packages: zsort.

Next: zsort/insertion-sort.lisp, Previous: zsort/packages.lisp, Up: Lisp [Contents][Index]

3.1.3 `zsort/base.lisp`

Dependency: packages.lisp (file).
Source: zsort.asd.
Parent Component: zsort (system).
Internals: sort-dispatch (macro).

Next: zsort/quicksort.lisp, Previous: zsort/base.lisp, Up: Lisp [Contents][Index]

3.1.4 `zsort/insertion-sort.lisp`

Dependency: base.lisp (file).
Source: zsort.asd.
Parent Component: zsort (system).
Public Interface: insertion-sort (function).
Internals: insertion-sort-body (macro).

Next: zsort/merge-sort.lisp, Previous: zsort/insertion-sort.lisp, Up: Lisp [Contents][Index]

3.1.5 `zsort/quicksort.lisp`

Dependency

insertion-sort.lisp (file).

Source

zsort.asd.

Parent Component

zsort (system).

Public Interface

quicksort (function).
randomized-quicksort (function).

Internals

bounded-random (function).
median-of-3-pivot (function).
median-pivot (function).
quicksort-body (macro).

Next: zsort/heapsort.lisp, Previous: zsort/quicksort.lisp, Up: Lisp [Contents][Index]

3.1.6 `zsort/merge-sort.lisp`

Dependency

quicksort.lisp (file).

Source

zsort.asd.

Parent Component

zsort (system).

Public Interface

merge-sort (function).

Internals

merge-sequences-body (macro).
merge-sort-body (macro).

Next: zsort/counting-sort.lisp, Previous: zsort/merge-sort.lisp, Up: Lisp [Contents][Index]

3.1.7 `zsort/heapsort.lisp`

Dependency

merge-sort.lisp (file).

Source

zsort.asd.

Parent Component

zsort (system).

Public Interface

heapsort (function).

Internals

build-heap (macro).
heapify (macro).
heapsort-body (macro).

Previous: zsort/heapsort.lisp, Up: Lisp [Contents][Index]

3.1.8 `zsort/counting-sort.lisp`

Dependency: heapsort.lisp (file).
Source: zsort.asd.
Parent Component: zsort (system).
Public Interface: counting-sort (function).
Internals: counting-sort-body (macro).

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

3.2 Static

zsort/README
zsort/LICENSE

Next: zsort/LICENSE, Previous: Static, Up: Static [Contents][Index]

3.2.1 `zsort/README`

Dependency: counting-sort.lisp (file).
Source: zsort.asd.
Parent Component: zsort (system).

Previous: zsort/README, Up: Static [Contents][Index]

3.2.2 `zsort/LICENSE`

Dependency: readme (file).
Source: zsort.asd.
Parent Component: zsort (system).

Next: Definitions, Previous: Files, Up: The zsort Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

zsort

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

4.1 `zsort`

zsort is a collection of portable sorting algorithms.

Source

packages.lisp.

Use List

common-lisp.

Public Interface

counting-sort (function).
heapsort (function).
insertion-sort (function).
merge-sort (function).
quicksort (function).
randomized-quicksort (function).

Internals

bounded-random (function).
build-heap (macro).
counting-sort-body (macro).
heapify (macro).
heapsort-body (macro).
insertion-sort-body (macro).
median-of-3-pivot (function).
median-pivot (function).
merge-sequences-body (macro).
merge-sort-body (macro).
quicksort-body (macro).
sort-dispatch (macro).

Next: Indexes, Previous: Packages, Up: The zsort 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: counting-sort (sequence &key ascend min max) ¶

Package: zsort.
Source: counting-sort.lisp.

Function: heapsort (sequence predicate &key key) ¶

Package: zsort.
Source: heapsort.lisp.

Function: insertion-sort (sequence predicate &key key) ¶

Package: zsort.
Source: insertion-sort.lisp.

Function: merge-sort (sequence predicate &key key) ¶

Package: zsort.
Source: merge-sort.lisp.

Function: quicksort (sequence predicate &key key) ¶

Package: zsort.
Source: quicksort.lisp.

Function: randomized-quicksort (sequence predicate &key key) ¶

Package: zsort.
Source: quicksort.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: build-heap (seq type len-1 pred &optional key) ¶

Package: zsort.
Source: heapsort.lisp.

Macro: counting-sort-body (type ref ascend sequence end min max) ¶

Package: zsort.
Source: counting-sort.lisp.

Macro: heapify (seq vector-ref root max pred &optional key) ¶

Package: zsort.
Source: heapsort.lisp.

Macro: heapsort-body (type ref predicate sequence key end) ¶

Package: zsort.
Source: heapsort.lisp.

Macro: insertion-sort-body (type ref predicate sequence key start end) ¶

Package: zsort.
Source: insertion-sort.lisp.

Macro: merge-sequences-body (type ref a start-a end-a b start-b end-b aux start-aux predicate &optional key) ¶

Package: zsort.
Source: merge-sort.lisp.

Macro: merge-sort-body (type ref mpredicate msequence mkey mstart mend) ¶

Package: zsort.
Source: merge-sort.lisp.

Macro: quicksort-body (type ref mpredicate msequence mkey mstart mend pick-pivot) ¶

Package: zsort.
Source: quicksort.lisp.

Macro: sort-dispatch (sort-body predicate sequence &rest args) ¶

Package: zsort.
Source: base.lisp.

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

5.2.2 Ordinary functions

Function: bounded-random (min max) ¶

Package: zsort.
Source: quicksort.lisp.

Function: median-of-3-pivot (start end) ¶

Package: zsort.
Source: quicksort.lisp.

Function: median-pivot (start end) ¶

Package: zsort.
Source: quicksort.lisp.

Previous: Definitions, Up: The zsort 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:	B C F H I M Q R S

	Index Entry	Section

B
	`bounded-random`:	Private ordinary functions
	`build-heap`:	Private macros

C
	`counting-sort`:	Public ordinary functions
	`counting-sort-body`:	Private macros

F
	`Function, bounded-random`:	Private ordinary functions
	`Function, counting-sort`:	Public ordinary functions
	`Function, heapsort`:	Public ordinary functions
	`Function, insertion-sort`:	Public ordinary functions
	`Function, median-of-3-pivot`:	Private ordinary functions
	`Function, median-pivot`:	Private ordinary functions
	`Function, merge-sort`:	Public ordinary functions
	`Function, quicksort`:	Public ordinary functions
	`Function, randomized-quicksort`:	Public ordinary functions

H
	`heapify`:	Private macros
	`heapsort`:	Public ordinary functions
	`heapsort-body`:	Private macros

I
	`insertion-sort`:	Public ordinary functions
	`insertion-sort-body`:	Private macros

M
	`Macro, build-heap`:	Private macros
	`Macro, counting-sort-body`:	Private macros
	`Macro, heapify`:	Private macros
	`Macro, heapsort-body`:	Private macros
	`Macro, insertion-sort-body`:	Private macros
	`Macro, merge-sequences-body`:	Private macros
	`Macro, merge-sort-body`:	Private macros
	`Macro, quicksort-body`:	Private macros
	`Macro, sort-dispatch`:	Private macros
	`median-of-3-pivot`:	Private ordinary functions
	`median-pivot`:	Private ordinary functions
	`merge-sequences-body`:	Private macros
	`merge-sort`:	Public ordinary functions
	`merge-sort-body`:	Private macros

Q
	`quicksort`:	Public ordinary functions
	`quicksort-body`:	Private macros

R
	`randomized-quicksort`:	Public ordinary functions

S
	`sort-dispatch`:	Private 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:	B C F H I L M P Q R S Z

	Index Entry	Section

B
	`base.lisp`:	The zsort/base․lisp file

C
	`counting-sort.lisp`:	The zsort/counting-sort․lisp file

F
	`File, base.lisp`:	The zsort/base․lisp file
	`File, counting-sort.lisp`:	The zsort/counting-sort․lisp file
	`File, heapsort.lisp`:	The zsort/heapsort․lisp file
	`File, insertion-sort.lisp`:	The zsort/insertion-sort․lisp file
	`File, license`:	The zsort/license file
	`File, merge-sort.lisp`:	The zsort/merge-sort․lisp file
	`File, packages.lisp`:	The zsort/packages․lisp file
	`File, quicksort.lisp`:	The zsort/quicksort․lisp file
	`File, readme`:	The zsort/readme file
	`File, zsort.asd`:	The zsort/zsort․asd file

H
	`heapsort.lisp`:	The zsort/heapsort․lisp file

I
	`insertion-sort.lisp`:	The zsort/insertion-sort․lisp file

L
	`license`:	The zsort/license file

M
	`merge-sort.lisp`:	The zsort/merge-sort․lisp file

P
	`Package, zsort`:	The zsort package
	`packages.lisp`:	The zsort/packages․lisp file

Q
	`quicksort.lisp`:	The zsort/quicksort․lisp file

R
	`readme`:	The zsort/readme file

S
	`System, zsort`:	The zsort system

Z
	`zsort`:	The zsort system
	`zsort`:	The zsort package
	`zsort.asd`:	The zsort/zsort․asd file

The zsort Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 zsort

3 Files

3.1 Lisp

3.1.1 zsort/zsort.asd

3.1.2 zsort/packages.lisp

3.1.3 zsort/base.lisp

3.1.4 zsort/insertion-sort.lisp

3.1.5 zsort/quicksort.lisp

3.1.6 zsort/merge-sort.lisp

3.1.7 zsort/heapsort.lisp

3.1.8 zsort/counting-sort.lisp

3.2 Static

3.2.1 zsort/README

3.2.2 zsort/LICENSE

4 Packages

4.1 zsort

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Macros

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `zsort`

3.1.1 `zsort/zsort.asd`

3.1.2 `zsort/packages.lisp`

3.1.3 `zsort/base.lisp`

3.1.4 `zsort/insertion-sort.lisp`

3.1.5 `zsort/quicksort.lisp`

3.1.6 `zsort/merge-sort.lisp`

3.1.7 `zsort/heapsort.lisp`

3.1.8 `zsort/counting-sort.lisp`

3.2.1 `zsort/README`

3.2.2 `zsort/LICENSE`

4.1 `zsort`