The lisp-interface-library Reference Manual

1 Introduction
2 Systems
3 Files
- 3.1 Lisp
4 Packages
5 Definitions
- 5.1 Exported definitions
- 5.2 Internal definitions
Appendix A Indexes

The lisp-interface-library Reference Manual

This is the lisp-interface-library Reference Manual, version 1.0.2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:39:47 2021 GMT+0.

1 Introduction

lisp-interface-library

LIL: abstract interfaces and concrete data structures in Common Lisp

Home Page: http://github.com/fare/lisp-interface-library/
We wrote an article explaining about our library for ILC'2012: http://github.com/fare/lil-ilc2012/
A PDF of a slightly corrected version of the article is here: http://common-lisp.net/~frideau/lil-ilc2012/lil-ilc2012.pdf
An HTML of that version of the article is here: http://common-lisp.net/~frideau/lil-ilc2012/lil-ilc2012.html
A short introduction on our "Interface-Passing Style" of programming, is also at: http://fare.livejournal.com/155094.html
Manual: I have never worked on a manual, nor on a tutorial. For a quick introduction to how things work, look at the tests in test/ for a few examples. Then docstrings and source code can get you somewhat further. A manual or a tutorial would be a great contribution to this library.

Features

LIL nicely combines ad-hoc polymorphism (CLOS-powered object oriented programming) and parametric polymorphism (as in ML functors, C++ templates, etc.). To our knowledge, only scalaz matches the expressiveness of LIL.
LIL sports both pure (persistent, immutable) and stateful (ephemeral, mutable) variants of data structures in Interface-Passing Style. This variants are in the respective packages PURE and STATEFUL; a common core is shared in package INTERFACE, covering read-only operations; automatic transforms allow bridging from stateful to pure and back.
LIL supports data structures in traditional Object-Oriented Style, in both stateful (the usual Object-Oriented kind) and pure variants, in the respective packages POSH and CLASSY. There too, automatic transforms to go from Interface-Passing Style to traditional Object-Oriented Style and back.

Building it

LIL needs to be built using ASDF 3.1 or later:

Indeed, LIL notably relies on ASDF 3.1's package-inferred-system. whereby instead of dependencies being listed in a central .asd file, each source file has a defpackage form from which the dependencies are deduced. While we think it's a great way to write Lisp code, you don't have to use it in your own code to use LIL.

LIL also depends on fare-utils, fare-memoization, closer-mop, alexandria.

Using it

See test/pure-map.lisp and test/stateful-map.lisp for examples of how to use LIL. Unhappily, no one is working on documentation at this time.

2 Systems

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

2.1 `lisp-interface-library`

Author: Francois-Rene Rideau
License: MIT
Description: Long name alias for lil
Version: 1.0.2.0
Dependency: lil (system)
Source: lisp-interface-library.asd (file)

2.2 `lil`

Author

Francois-Rene Rideau

License

MIT

Description

LIL: Lisp Interface Library

Long Description

LIL is a collection of pure and stateful data structures in Interface Passing Style. See http://fare.livejournal.com/155094.html regarding Interface Passing Style, or our ILC’2012 article http://github.com/fare/lil-ilc2012/

Version

1.0.2.0

Dependencies

lil/core/all (system)
lil/interface/all (system)
lil/pure/all (system)
lil/stateful/all (system)
lil/transform/all (system)
fare-memoization (at least version 1.2.0)

Source

lil.asd (file)

2.3 `lil/transform/all`

Author

Francois-Rene Rideau

License

MIT

Dependencies

lil/pure/all (system)
lil/stateful/all (system)
lil/transform/linearize (system)
lil/transform/linearized-map (system)
lil/transform/mutating (system)
lil/transform/mutating-map (system)
lil/transform/classify (system)
lil/transform/classy (system)
lil/transform/posh (system)

Source

lil.asd (file)

Component

• Introduction		What lisp-interface-library is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The lisp-interface-library system
• The lil system
• The lil/transform/all system
• The lil/pure/all system
• The lil/pure/lexicographic system
• The lil/pure/sequence system
• The lil/pure/iterator-implementation system
• The lil/pure/map-implementation system
• The lil/pure/set-implementation system
• The lil/pure/set system
• The lil/pure/alist-implementation system
• The lil/pure/tree-implementation system
• The lil/pure/hash-table-implementation system
• The lil/pure/fmim-implementation system
• The lil/pure/fmim system
• The lil/pure/encoded-key-map-implementation system
• The lil/pure/queue-implementation system
• The lil/stateful/all system
• The lil/interface/all system
• The lil/interface/sequence system
• The lil/interface/set system
• The lil/interface/tree-implementation system
• The lil/interface/monad/continuation system
• The lil/interface/monad/state system
• The lil/interface/run system
• The lil/interface/monad/transformer/list system
• The lil/interface/monad/list system
• The lil/interface/monad/transformer/maybe system
• The lil/interface/monad/maybe system
• The lil/interface/monad/transformer system
• The lil/interface/monad/identity system
• The lil/interface/monad system
• The lil/stateful/iterator-implementation system
• The lil/stateful/tree-implementation system
• The lil/stateful/hash-table-implementation system
• The lil/stateful/map-implementation system
• The lil/stateful/hash-table system
• The lil/stateful/encoded-key-map-implementation system
• The lil/stateful/encoded-key-map system
• The lil/stateful/queue-implementation system
• The lil/transform/linearized-map system
• The lil/transform/linearize system
• The lil/transform/mutating-map system
• The lil/transform/mutating system
• The lil/transform/posh system
• The lil/pure/hash-table system
• The lil/pure/tree system
• The lil/pure/alist system
• The lil/pure/encoded-key-map system
• The lil/pure/map system
• The lil/pure/queue system
• The lil/pure/iterator system
• The lil/pure/collection system
• The lil/pure/empty system
• The lil/transform/classy system
• The lil/transform/classify system
• The lil/interface/box system
• The lil/stateful/tree system
• The lil/interface/tree system
• The lil/interface/order system
• The lil/interface/eq system
• The lil/stateful/map system
• The lil/interface/map system
• The lil/stateful/queue system
• The lil/stateful/iterator system
• The lil/stateful/collection system
• The lil/stateful/empty system
• The lil/interface/collection system
• The lil/interface/fold system
• The lil/interface/size system
• The lil/interface/group system
• The lil/interface/empty system
• The lil/interface/iterator system
• The lil/interface/base system
• The lil/core/all system
• The lil/core/interface system
• The lil/core/metaclass system
• The lil/core/utility system

• The lisp-interface-library.asd file
• The lil.asd file
• The lil/transform/all/file-type.lisp file
• The lil/pure/all/file-type.lisp file
• The lil/pure/lexicographic/file-type.lisp file
• The lil/pure/sequence/file-type.lisp file
• The lil/pure/iterator-implementation/file-type.lisp file
• The lil/pure/map-implementation/file-type.lisp file
• The lil/pure/set-implementation/file-type.lisp file
• The lil/pure/set/file-type.lisp file
• The lil/pure/alist-implementation/file-type.lisp file
• The lil/pure/tree-implementation/file-type.lisp file
• The lil/pure/hash-table-implementation/file-type.lisp file
• The lil/pure/fmim-implementation/file-type.lisp file
• The lil/pure/fmim/file-type.lisp file
• The lil/pure/encoded-key-map-implementation/file-type.lisp file
• The lil/pure/queue-implementation/file-type.lisp file
• The lil/stateful/all/file-type.lisp file
• The lil/interface/all/file-type.lisp file
• The lil/interface/sequence/file-type.lisp file
• The lil/interface/set/file-type.lisp file
• The lil/interface/tree-implementation/file-type.lisp file
• The lil/interface/monad/continuation/file-type.lisp file
• The lil/interface/monad/state/file-type.lisp file
• The lil/interface/run/file-type.lisp file
• The lil/interface/monad/transformer/list/file-type.lisp file
• The lil/interface/monad/list/file-type.lisp file
• The lil/interface/monad/transformer/maybe/file-type.lisp file
• The lil/interface/monad/maybe/file-type.lisp file
• The lil/interface/monad/transformer/file-type.lisp file
• The lil/interface/monad/identity/file-type.lisp file
• The lil/interface/monad/file-type.lisp file
• The lil/stateful/iterator-implementation/file-type.lisp file
• The lil/stateful/tree-implementation/file-type.lisp file
• The lil/stateful/hash-table-implementation/file-type.lisp file
• The lil/stateful/map-implementation/file-type.lisp file
• The lil/stateful/hash-table/file-type.lisp file
• The lil/stateful/encoded-key-map-implementation/file-type.lisp file
• The lil/stateful/encoded-key-map/file-type.lisp file
• The lil/stateful/queue-implementation/file-type.lisp file
• The lil/transform/linearized-map/file-type.lisp file
• The lil/transform/linearize/file-type.lisp file
• The lil/transform/mutating-map/file-type.lisp file
• The lil/transform/mutating/file-type.lisp file
• The lil/transform/posh/file-type.lisp file
• The lil/pure/hash-table/file-type.lisp file
• The lil/pure/tree/file-type.lisp file
• The lil/pure/alist/file-type.lisp file
• The lil/pure/encoded-key-map/file-type.lisp file
• The lil/pure/map/file-type.lisp file
• The lil/pure/queue/file-type.lisp file
• The lil/pure/iterator/file-type.lisp file
• The lil/pure/collection/file-type.lisp file
• The lil/pure/empty/file-type.lisp file
• The lil/transform/classy/file-type.lisp file
• The lil/transform/classify/file-type.lisp file
• The lil/interface/box/file-type.lisp file
• The lil/stateful/tree/file-type.lisp file
• The lil/interface/tree/file-type.lisp file
• The lil/interface/order/file-type.lisp file
• The lil/interface/eq/file-type.lisp file
• The lil/stateful/map/file-type.lisp file
• The lil/interface/map/file-type.lisp file
• The lil/stateful/queue/file-type.lisp file
• The lil/stateful/iterator/file-type.lisp file
• The lil/stateful/collection/file-type.lisp file
• The lil/stateful/empty/file-type.lisp file
• The lil/interface/collection/file-type.lisp file
• The lil/interface/fold/file-type.lisp file
• The lil/interface/size/file-type.lisp file
• The lil/interface/group/file-type.lisp file
• The lil/interface/empty/file-type.lisp file
• The lil/interface/iterator/file-type.lisp file
• The lil/interface/base/file-type.lisp file
• The lil/core/all/file-type.lisp file
• The lil/core/interface/file-type.lisp file
• The lil/core/metaclass/file-type.lisp file
• The lil/core/utility/file-type.lisp file

• The lil/transform/all package
• The lil/pure/all package
• The lil/pure/lexicographic package
• The lil/pure/sequence package
• The lil/pure/iterator-implementation package
• The lil/pure/map-implementation package
• The lil/pure/set-implementation package
• The lil/pure/set package
• The lil/pure/alist-implementation package
• The lil/pure/tree-implementation package
• The lil/pure/hash-table-implementation package
• The lil/pure/fmim-implementation package
• The lil/pure/fmim package
• The lil/pure/encoded-key-map-implementation package
• The lil/pure/queue-implementation package
• The lil/stateful/all package
• The lil/interface/all package
• The lil/interface/sequence package
• The lil/interface/set package
• The lil/interface/tree-implementation package
• The lil/interface/monad/continuation package
• The lil/interface/monad/state package
• The lil/interface/run package
• The lil/interface/monad/transformer/list package
• The lil/interface/monad/list package
• The lil/interface/monad/transformer/maybe package
• The lil/interface/monad/maybe package
• The lil/interface/monad/transformer package
• The lil/interface/monad/identity package
• The lil/interface/monad package
• The lil/stateful/iterator-implementation package
• The lil/stateful/tree-implementation package
• The lil/stateful/hash-table-implementation package
• The lil/stateful/map-implementation package
• The lil/stateful/hash-table package
• The lil/stateful/encoded-key-map-implementation package
• The lil/stateful/encoded-key-map package
• The lil/stateful/queue-implementation package
• The lil/transform/linearized-map package
• The lil/transform/linearize package
• The lil/transform/mutating-map package
• The lil/transform/mutating package
• The lil/transform/posh package
• The lil/pure/hash-table package
• The lil/pure/tree package
• The lil/pure/alist package
• The lil/pure/encoded-key-map package
• The lil/pure/map package
• The lil/pure/queue package
• The lil/pure/iterator package
• The lil/pure/collection package
• The lil/pure/empty package
• The lil/transform/classy package
• The lil/transform/classify package
• The lil/interface/box package
• The lil/stateful/tree package
• The lil/interface/tree package
• The lil/interface/order package
• The lil/interface/eq package
• The lil/stateful/map package
• The lil/interface/map package
• The lil/stateful/queue package
• The lil/stateful/iterator package
• The lil/stateful/collection package
• The lil/stateful/empty package
• The lil/interface/collection package
• The lil/interface/fold package
• The lil/interface/size package
• The lil/interface/group package
• The lil/interface/empty package
• The lil/interface/iterator package
• The lil/interface/base package
• The lil/core/all package
• The lil/core/interface package
• The lil/core/metaclass package
• The lil/core/utility package

The lisp-interface-library Reference Manual

Table of Contents

The lisp-interface-library Reference Manual

1 Introduction

lisp-interface-library

Features

Building it

Using it

2 Systems

2.1 lisp-interface-library

2.2 lil

2.3 lil/transform/all

2.4 lil/pure/all

2.5 lil/pure/lexicographic

2.6 lil/pure/sequence

2.7 lil/pure/iterator-implementation

2.8 lil/pure/map-implementation

2.9 lil/pure/set-implementation

2.10 lil/pure/set

2.11 lil/pure/alist-implementation

2.12 lil/pure/tree-implementation

2.13 lil/pure/hash-table-implementation

2.14 lil/pure/fmim-implementation

2.15 lil/pure/fmim

2.16 lil/pure/encoded-key-map-implementation

2.17 lil/pure/queue-implementation

2.18 lil/stateful/all

2.19 lil/interface/all

2.20 lil/interface/sequence

2.21 lil/interface/set

2.22 lil/interface/tree-implementation

2.23 lil/interface/monad/continuation

2.24 lil/interface/monad/state

2.25 lil/interface/run

2.26 lil/interface/monad/transformer/list

2.27 lil/interface/monad/list

2.28 lil/interface/monad/transformer/maybe

2.29 lil/interface/monad/maybe

2.30 lil/interface/monad/transformer

2.31 lil/interface/monad/identity

2.32 lil/interface/monad

2.33 lil/stateful/iterator-implementation

2.34 lil/stateful/tree-implementation

2.35 lil/stateful/hash-table-implementation

2.36 lil/stateful/map-implementation

2.37 lil/stateful/hash-table

2.38 lil/stateful/encoded-key-map-implementation

2.39 lil/stateful/encoded-key-map

2.40 lil/stateful/queue-implementation

2.41 lil/transform/linearized-map

2.42 lil/transform/linearize

2.43 lil/transform/mutating-map

2.44 lil/transform/mutating

2.45 lil/transform/posh

2.46 lil/pure/hash-table

2.47 lil/pure/tree

2.48 lil/pure/alist

2.49 lil/pure/encoded-key-map

2.50 lil/pure/map

2.51 lil/pure/queue

2.52 lil/pure/iterator

2.53 lil/pure/collection

2.54 lil/pure/empty

2.55 lil/transform/classy

2.56 lil/transform/classify

2.57 lil/interface/box

2.58 lil/stateful/tree

2.59 lil/interface/tree

2.60 lil/interface/order

2.61 lil/interface/eq

2.62 lil/stateful/map

2.63 lil/interface/map

2.64 lil/stateful/queue

2.65 lil/stateful/iterator

2.66 lil/stateful/collection

2.67 lil/stateful/empty

2.68 lil/interface/collection

2.69 lil/interface/fold

2.70 lil/interface/size

2.71 lil/interface/group

2.1 `lisp-interface-library`

2.2 `lil`

2.3 `lil/transform/all`

2.4 `lil/pure/all`

2.5 `lil/pure/lexicographic`

2.6 `lil/pure/sequence`

2.7 `lil/pure/iterator-implementation`

2.8 `lil/pure/map-implementation`

2.9 `lil/pure/set-implementation`

2.10 `lil/pure/set`

2.11 `lil/pure/alist-implementation`

2.12 `lil/pure/tree-implementation`

2.13 `lil/pure/hash-table-implementation`

2.14 `lil/pure/fmim-implementation`

2.15 `lil/pure/fmim`

2.16 `lil/pure/encoded-key-map-implementation`

2.17 `lil/pure/queue-implementation`

2.18 `lil/stateful/all`

2.19 `lil/interface/all`

2.20 `lil/interface/sequence`

2.21 `lil/interface/set`

2.22 `lil/interface/tree-implementation`

2.23 `lil/interface/monad/continuation`

2.24 `lil/interface/monad/state`

2.25 `lil/interface/run`

2.26 `lil/interface/monad/transformer/list`

2.27 `lil/interface/monad/list`

2.28 `lil/interface/monad/transformer/maybe`

2.29 `lil/interface/monad/maybe`

2.30 `lil/interface/monad/transformer`

2.31 `lil/interface/monad/identity`

2.32 `lil/interface/monad`

2.33 `lil/stateful/iterator-implementation`

2.34 `lil/stateful/tree-implementation`

2.35 `lil/stateful/hash-table-implementation`

2.36 `lil/stateful/map-implementation`

2.37 `lil/stateful/hash-table`

2.38 `lil/stateful/encoded-key-map-implementation`

2.39 `lil/stateful/encoded-key-map`

2.40 `lil/stateful/queue-implementation`

2.41 `lil/transform/linearized-map`

2.42 `lil/transform/linearize`

2.43 `lil/transform/mutating-map`

2.44 `lil/transform/mutating`

2.45 `lil/transform/posh`

2.46 `lil/pure/hash-table`

2.47 `lil/pure/tree`

2.48 `lil/pure/alist`

2.49 `lil/pure/encoded-key-map`

2.50 `lil/pure/map`

2.51 `lil/pure/queue`

2.52 `lil/pure/iterator`

2.53 `lil/pure/collection`

2.54 `lil/pure/empty`

2.55 `lil/transform/classy`

2.56 `lil/transform/classify`

2.57 `lil/interface/box`

2.58 `lil/stateful/tree`

2.59 `lil/interface/tree`

2.60 `lil/interface/order`

2.61 `lil/interface/eq`

2.62 `lil/stateful/map`

2.63 `lil/interface/map`

2.64 `lil/stateful/queue`

2.65 `lil/stateful/iterator`

2.66 `lil/stateful/collection`

2.67 `lil/stateful/empty`

2.68 `lil/interface/collection`

2.69 `lil/interface/fold`

2.70 `lil/interface/size`

2.71 `lil/interface/group`

2.72 `lil/interface/empty`

2.73 `lil/interface/iterator`

2.74 `lil/interface/base`

2.75 `lil/core/all`

2.76 `lil/core/interface`

2.77 `lil/core/metaclass`

2.78 `lil/core/utility`

3.1.1 `lisp-interface-library.asd`

3.1.2 `lil.asd`