The algebraic-data-library Reference Manual

Table of Contents

The algebraic-data-library Reference Manual

This is the algebraic-data-library Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 16:49:33 2020 GMT+0.

1 Systems

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

1.1 algebraic-data-library

Author

Robert Smith <quad@symbo1ics.com>

License

BSD 3-clause

Description

A library of common algebraic data types.

Dependency

cl-algebraic-data-type

Source

algebraic-data-library.asd (file)

Components

• package.lisp (file)
• generics.lisp (file)
• unit.lisp (file)
• maybe.lisp (file)
• either.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 algebraic-data-library.asd

Location

algebraic-data-library.asd

Systems

algebraic-data-library (system)

2.1.2 algebraic-data-library/package.lisp

Parent

algebraic-data-library (system)

Location

package.lisp

Packages

algebraic-data-library

2.1.3 algebraic-data-library/generics.lisp

Dependency

package.lisp (file)

Parent

algebraic-data-library (system)

Location

generics.lisp

Exported Definitions

• >> (generic function)
• >> (method)
• >>= (generic function)
• fmap (generic function)
• fmap* (function)
• mlet (macro)
• wrap (generic function)

2.1.4 algebraic-data-library/unit.lisp

Dependency

generics.lisp (file)

Parent

algebraic-data-library (system)

Location

unit.lisp

Exported Definitions

• nul (constant)
• nul (structure)
• unit (structure)

2.1.5 algebraic-data-library/maybe.lisp

Dependency

unit.lisp (file)

Parent

algebraic-data-library (system)

Location

maybe.lisp

Exported Definitions

• >>= (method)
• fmap (method)
• just (function)
• just (structure)
• just-or-else (function)
• lookup (function)
• maybe (structure)
• nothing (constant)
• nothing (structure)
• wrap (method)

Internal Definitions

just%0 (function)

2.1.6 algebraic-data-library/either.lisp

Dependency

maybe.lisp (file)

Parent

algebraic-data-library (system)

Location

either.lisp

Exported Definitions

• either (structure)
• fmap (method)
• left (function)
• left (structure)
• mirror (function)
• right (function)
• right (structure)

Internal Definitions

• left%0 (function)
• right%0 (function)

3 Packages

Packages are listed by definition order.

3.1 algebraic-data-library

Source

package.lisp (file)

Nickname

adl

Use List

common-lisp

Exported Definitions

• >> (generic function)
• >> (method)
• >>= (generic function)
• >>= (method)
• either (structure)
• fmap (generic function)
• fmap (method)
• fmap (method)
• fmap* (function)
• just (function)
• just (structure)
• just-or-else (function)
• left (function)
• left (structure)
• lookup (function)
• maybe (structure)
• mirror (function)
• mlet (macro)
• nothing (constant)
• nothing (structure)
• nul (constant)
• nul (structure)
• right (function)
• right (structure)
• unit (structure)
• wrap (generic function)
• wrap (method)

Internal Definitions

• just%0 (function)
• left%0 (function)
• right%0 (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Constants

Constant: nothing

Package

algebraic-data-library

Source

maybe.lisp (file)

Constant: nul

Package

algebraic-data-library

Source

unit.lisp (file)

4.1.2 Macros

Macro: mlet BINDINGS &body BODY

Similar to Haskell’s ‘do’ notation, allows for ‘>>=’ to be chained together.

Package

algebraic-data-library

Source

generics.lisp (file)

4.1.3 Functions

Function: fmap* FUN

A curried version of FMAP: lift FUN to operate on functor types.

Package

algebraic-data-library

Source

generics.lisp (file)

Function: just %0

Package

algebraic-data-library

Source

maybe.lisp (file)

Function: just-or-else MAYBE-VAL OR-ELSE

Return the encapsulated value of a JUST, otherwise return OR-ELSE if MAYBE-VAL is NOTHING.

Package

algebraic-data-library

Source

maybe.lisp (file)

Function: left %0

Package

algebraic-data-library

Source

either.lisp (file)

Function: lookup KEY HASH-TABLE

A type-safe version of GETHASH. Look up the key KEY in the hash table HASH-TABLE.

Package

algebraic-data-library

Source

maybe.lisp (file)

Function: mirror EITHER-VAL

Package

algebraic-data-library

Source

either.lisp (file)

Function: right %0

Package

algebraic-data-library

Source

either.lisp (file)

4.1.4 Generic functions

Generic Function: >> A B

Compute A and then B, discarding A.

Package

algebraic-data-library

Source

generics.lisp (file)

Methods

Method: >> A B

Generic Function: >>= VAL F

Send/compose the result of VAL to F.

Package

algebraic-data-library

Source

generics.lisp (file)

Methods

Method: >>= (VAL maybe) F

Source

maybe.lisp (file)

Generic Function: fmap FUN VAL

A way to lift FUN into a container-like value VAL.

Package

algebraic-data-library

Source

generics.lisp (file)

Methods

Method: fmap (F function) (VAL either)

Source

either.lisp (file)

Method: fmap (F function) (VAL maybe)

Source

maybe.lisp (file)

Generic Function: wrap TYPE VALUE

Lift VALUE to type TYPE.

Package

algebraic-data-library

Source

generics.lisp (file)

Methods

Method: wrap (X (eql maybe)) VALUE

Source

maybe.lisp (file)

4.1.5 Structures

Structure: either ()

Package

algebraic-data-library

Source

either.lisp (file)

Direct superclasses

algebraic-data-type (structure)

Direct subclasses

• left (structure)
• right (structure)

Direct methods

fmap (method)

Structure: just ()

Package

algebraic-data-library

Source

maybe.lisp (file)

Direct superclasses

maybe (structure)

Direct methods

• make-load-form (method)
• print-object (method)

Direct slots

Slot: %0

Initform

(error "unspecified field.")

Readers

just%0 (function)

Writers

(setf just%0) (function)

Structure: left ()

Package

algebraic-data-library

Source

either.lisp (file)

Direct superclasses

either (structure)

Direct methods

• make-load-form (method)
• print-object (method)

Direct slots

Slot: %0

Initform

(error "unspecified field.")

Readers

left%0 (function)

Writers

(setf left%0) (function)

Structure: maybe ()

Package

algebraic-data-library

Source

maybe.lisp (file)

Direct superclasses

algebraic-data-type (structure)

Direct subclasses

• just (structure)
• nothing (structure)

Direct methods

• >>= (method)
• fmap (method)

Structure: nothing ()

Package

algebraic-data-library

Source

maybe.lisp (file)

Direct superclasses

maybe (structure)

Direct methods

• make-load-form (method)
• print-object (method)

Structure: nul ()

Package

algebraic-data-library

Source

unit.lisp (file)

Direct superclasses

unit (structure)

Direct methods

• make-load-form (method)
• print-object (method)

Structure: right ()

Package

algebraic-data-library

Source

either.lisp (file)

Direct superclasses

either (structure)

Direct methods

• make-load-form (method)
• print-object (method)

Direct slots

Slot: %0

Initform

(error "unspecified field.")

Readers

right%0 (function)

Writers

(setf right%0) (function)

Structure: unit ()

Package

algebraic-data-library

Source

unit.lisp (file)

Direct superclasses

algebraic-data-type (structure)

Direct subclasses

nul (structure)

4.2 Internal definitions

4.2.1 Functions

Function: just%0 INSTANCE

Package

algebraic-data-library

Source

maybe.lisp (file)

Function: left%0 INSTANCE

Package

algebraic-data-library

Source

either.lisp (file)

Function: right%0 INSTANCE

Package

algebraic-data-library

Source

either.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types