The clj Reference Manual

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

The clj Reference Manual

This is the clj Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 05:22:15 2022 GMT+0.

Table of Contents


1 Introduction

clj

inaimathi leo.zovic@gmail.com

Build Status

Some conveniences from the Clojure world. Because they've got some good ideas, but dammit, I'm a Common Lisper.

License

MIT Expat, the way Clojure can't be


2 Systems

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


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

2.1 clj

Some clojure conveniences for Common Lisp

Author

inaimathi <leo.zovic@gmail.com>

License

MIT Expat <https://www.debian.org/legal/licenses/mit>

Version

0.0.1

Dependencies
  • named-readtables (system).
  • cl-hamt (system).
  • optima (system).
  • arrow-macros (system).
  • test-utils (system).
  • local-package-aliases (system).
  • agnostic-lizard (system).
Source

clj.asd.

Child Component

src (module).


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 clj/src

Source

clj.asd.

Parent Component

clj (system).

Child Components

4 Files

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


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

4.1 Lisp


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

4.1.1 clj/clj.asd

Source

clj.asd.

Parent Component

clj (system).

ASDF Systems

clj.


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

4.1.2 clj/src/package.lisp

Source

clj.asd.

Parent Component

src (module).

Packages

clj.


4.1.3 clj/src/types.lisp

Source

clj.asd.

Parent Component

src (module).

Public Interface

~ (macro).

Internals

4.1.4 clj/src/syntax.lisp

Source

clj.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 clj/src/generics.lisp

Source

clj.asd.

Parent Component

src (module).

Public Interface

4.1.6 clj/src/map.lisp

Source

clj.asd.

Parent Component

src (module).

Public Interface

4.1.7 clj/src/set.lisp

Source

clj.asd.

Parent Component

src (module).

Public Interface

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

4.1.8 clj/src/generators.lisp

Source

clj.asd.

Parent Component

src (module).


4.1.9 clj/src/clj.lisp

Source

clj.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


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

5.1 clj

Source

package.lisp.

Use List
  • arrow-macros.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


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

6.1 Public Interface


6.1.1 Macros

Macro: as (&rest package/alias-pairs)

as duplicates local-package-aliases:set, but checks that the aliased packages exist before establishing them.

Package

clj.

Source

clj.lisp.

Macro: fn (&rest args)
Package

clj.

Source

clj.lisp.

Macro: if-let ((name test) then &optional else)
Package

clj.

Source

clj.lisp.

Macro: when-let ((name test) &body then)
Package

clj.

Source

clj.lisp.

Macro: ~ (exp type)
Package

clj.

Source

types.lisp.


6.1.2 Ordinary functions

Function: alist->map (alist &key equality)
Package

clj.

Source

syntax.lisp.

Function: dec (num)
Package

clj.

Source

clj.lisp.

Function: inc (num)
Package

clj.

Source

clj.lisp.

Function: list->set (lst)
Package

clj.

Source

syntax.lisp.

Function: map? (thing)
Package

clj.

Source

map.lisp.

Function: set? (thing)
Package

clj.

Source

set.lisp.

Function: walk (f container)
Package

clj.

Source

generics.lisp.


6.1.3 Generic functions

Generic Function: == (a b)
Package

clj.

Source

generics.lisp.

Methods
Method: == ((a hash-set) (b hash-set))
Source

set.lisp.

Method: == ((a hash-dict) (b hash-dict))
Source

map.lisp.

Method: == ((a list) (b list))
Method: == ((a symbol) (b symbol))
Method: == ((a character) (b character))
Method: == ((a string) (b string))
Method: == ((a number) (b number))
Method: == (a b)
Generic Function: as-list (container)
Package

clj.

Source

generics.lisp.

Methods
Method: as-list ((container hash-set))
Source

set.lisp.

Method: as-list ((container hash-dict))
Source

map.lisp.

Method: as-list ((container hash-table))
Method: as-list ((container list))
Generic Function: contains? (container elem)
Package

clj.

Source

generics.lisp.

Methods
Method: contains? ((container hash-set) elem)
Source

set.lisp.

Method: contains? ((container hash-dict) elem)
Source

map.lisp.

Method: contains? ((container string) (elem character))
Method: contains? ((container hash-table) elem)
Method: contains? ((container list) elem)
Generic Function: difference (a &rest sets)
Package

clj.

Methods
Method: difference ((a hash-set) &rest sets)
Source

set.lisp.

Generic Function: dissoc (container &rest ks-or-elems)
Package

clj.

Source

generics.lisp.

Methods
Method: dissoc ((container hash-set) &rest ks-or-elems)
Source

set.lisp.

Method: dissoc ((container hash-dict) &rest ks-or-elems)
Source

map.lisp.

Method: dissoc ((container hash-table) &rest ks-or-elems)
Method: dissoc ((container list) &rest ks-or-elems)
Generic Function: empty? (container)
Package

clj.

Source

generics.lisp.

Methods
Method: empty? ((container string))
Method: empty? ((container hash-table))
Method: empty? ((container list))
Generic Function: fmap (f container)
Package

clj.

Source

generics.lisp.

Methods
Method: fmap ((f function) (container hash-set))
Source

set.lisp.

Method: fmap ((f function) (container hash-dict))
Source

map.lisp.

Method: fmap ((f function) (container hash-table))
Method: fmap ((f function) (container list))
Generic Function: insert (container &rest args)
Package

clj.

Source

generics.lisp.

Methods
Method: insert ((container hash-set) &rest args)
Source

set.lisp.

Method: insert ((container hash-dict) &rest args)
Source

map.lisp.

Method: insert ((container hash-table) &rest args)
Method: insert ((container list) &rest args)
Generic Function: invert (container)
Package

clj.

Source

generics.lisp.

Methods
Method: invert ((container hash-dict))
Source

map.lisp.

Method: invert ((container hash-table))
Method: invert ((container list))
Generic Function: len (container)
Package

clj.

Source

generics.lisp.

Methods
Method: len ((container hash-set))
Source

set.lisp.

Method: len ((container hash-dict))
Source

map.lisp.

Method: len ((container string))
Method: len ((container hash-table))
Method: len ((container list))
Generic Function: lookup (container key &key default)
Package

clj.

Source

generics.lisp.

Methods
Method: lookup ((container hash-set) key &key default)
Source

set.lisp.

Method: lookup ((container hash-dict) key &key default)
Source

map.lisp.

Method: lookup ((container hash-table) key &key default)
Method: lookup ((container list) key &key default)
Generic Function: merge-with (f a b)
Package

clj.

Methods
Method: merge-with ((f function) (a hash-dict) (b hash-dict))
Source

map.lisp.

Generic Function: seq? (container)
Package

clj.

Source

generics.lisp.

Methods
Method: seq? ((container hash-set))
Source

set.lisp.

Method: seq? ((container hash-dict))
Source

map.lisp.

Method: seq? ((container hash-table))
Method: seq? ((container list))
Method: seq? (thing)
Generic Function: union (container &rest containers)
Package

clj.

Source

generics.lisp.

Methods
Method: union ((a hash-set) &rest sets)
Source

set.lisp.

Method: union ((container list) &rest lists)
Generic Function: update (container k f)
Package

clj.

Methods
Method: update ((container hash-dict) k f)
Source

map.lisp.


6.2 Internals


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

6.2.1 Special variables

Special Variable: *type*
Package

clj.

Source

types.lisp.


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

6.2.2 Ordinary functions

Function: equality-function (name)
Package

clj.

Source

types.lisp.

Function: equality-of (type)
Package

clj.

Source

types.lisp.

Function: fullest-equality (equalities)
Package

clj.

Source

types.lisp.

Function: kv-types (k-type v-type)
Package

clj.

Source

types.lisp.

Function: list->map (lst &key equality)
Package

clj.

Source

syntax.lisp.

Function: map-literal-reader (stream char)
Package

clj.

Source

syntax.lisp.

Function: map-type? (type)
Package

clj.

Source

types.lisp.

Function: seq-types (v-type)
Package

clj.

Source

types.lisp.

Function: set-literal-reader (stream sub-char numarg)
Package

clj.

Source

syntax.lisp.

Function: set-type? (type)
Package

clj.

Source

types.lisp.

Function: string-template-reader (stream sub-char numarg)
Package

clj.

Source

syntax.lisp.


6.2.3 Types

Type: map (&optional keys vals)
Package

clj.

Source

types.lisp.

Type: set (&optional vals)
Package

clj.

Source

types.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   =   ~  
A   C   D   E   F   G   I   K   L   M   S   U   W  
Index Entry  Section

=
==: Public generic functions
==: Public generic functions
==: Public generic functions
==: Public generic functions
==: Public generic functions
==: Public generic functions
==: Public generic functions
==: Public generic functions
==: Public generic functions

~
~: Public macros

A
alist->map: Public ordinary functions
as: Public macros
as-list: Public generic functions
as-list: Public generic functions
as-list: Public generic functions
as-list: Public generic functions
as-list: Public generic functions

C
contains?: Public generic functions
contains?: Public generic functions
contains?: Public generic functions
contains?: Public generic functions
contains?: Public generic functions
contains?: Public generic functions

D
dec: Public ordinary functions
difference: Public generic functions
difference: Public generic functions
dissoc: Public generic functions
dissoc: Public generic functions
dissoc: Public generic functions
dissoc: Public generic functions
dissoc: Public generic functions

E
empty?: Public generic functions
empty?: Public generic functions
empty?: Public generic functions
empty?: Public generic functions
equality-function: Private ordinary functions
equality-of: Private ordinary functions

F
fmap: Public generic functions
fmap: Public generic functions
fmap: Public generic functions
fmap: Public generic functions
fmap: Public generic functions
fn: Public macros
fullest-equality: Private ordinary functions
Function, alist->map: Public ordinary functions
Function, dec: Public ordinary functions
Function, equality-function: Private ordinary functions
Function, equality-of: Private ordinary functions
Function, fullest-equality: Private ordinary functions
Function, inc: Public ordinary functions
Function, kv-types: Private ordinary functions
Function, list->map: Private ordinary functions
Function, list->set: Public ordinary functions
Function, map-literal-reader: Private ordinary functions
Function, map-type?: Private ordinary functions
Function, map?: Public ordinary functions
Function, seq-types: Private ordinary functions
Function, set-literal-reader: Private ordinary functions
Function, set-type?: Private ordinary functions
Function, set?: Public ordinary functions
Function, string-template-reader: Private ordinary functions
Function, walk: Public ordinary functions

G
Generic Function, ==: Public generic functions
Generic Function, as-list: Public generic functions
Generic Function, contains?: Public generic functions
Generic Function, difference: Public generic functions
Generic Function, dissoc: Public generic functions
Generic Function, empty?: Public generic functions
Generic Function, fmap: Public generic functions
Generic Function, insert: Public generic functions
Generic Function, invert: Public generic functions
Generic Function, len: Public generic functions
Generic Function, lookup: Public generic functions
Generic Function, merge-with: Public generic functions
Generic Function, seq?: Public generic functions
Generic Function, union: Public generic functions
Generic Function, update: Public generic functions

I
if-let: Public macros
inc: Public ordinary functions
insert: Public generic functions
insert: Public generic functions
insert: Public generic functions
insert: Public generic functions
insert: Public generic functions
invert: Public generic functions
invert: Public generic functions
invert: Public generic functions
invert: Public generic functions

K
kv-types: Private ordinary functions

L
len: Public generic functions
len: Public generic functions
len: Public generic functions
len: Public generic functions
len: Public generic functions
len: Public generic functions
list->map: Private ordinary functions
list->set: Public ordinary functions
lookup: Public generic functions
lookup: Public generic functions
lookup: Public generic functions
lookup: Public generic functions
lookup: Public generic functions

M
Macro, as: Public macros
Macro, fn: Public macros
Macro, if-let: Public macros
Macro, when-let: Public macros
Macro, ~: Public macros
map-literal-reader: Private ordinary functions
map-type?: Private ordinary functions
map?: Public ordinary functions
merge-with: Public generic functions
merge-with: Public generic functions
Method, ==: Public generic functions
Method, ==: Public generic functions
Method, ==: Public generic functions
Method, ==: Public generic functions
Method, ==: Public generic functions
Method, ==: Public generic functions
Method, ==: Public generic functions
Method, ==: Public generic functions
Method, as-list: Public generic functions
Method, as-list: Public generic functions
Method, as-list: Public generic functions
Method, as-list: Public generic functions
Method, contains?: Public generic functions
Method, contains?: Public generic functions
Method, contains?: Public generic functions
Method, contains?: Public generic functions
Method, contains?: Public generic functions
Method, difference: Public generic functions
Method, dissoc: Public generic functions
Method, dissoc: Public generic functions
Method, dissoc: Public generic functions
Method, dissoc: Public generic functions
Method, empty?: Public generic functions
Method, empty?: Public generic functions
Method, empty?: Public generic functions
Method, fmap: Public generic functions
Method, fmap: Public generic functions
Method, fmap: Public generic functions
Method, fmap: Public generic functions
Method, insert: Public generic functions
Method, insert: Public generic functions
Method, insert: Public generic functions
Method, insert: Public generic functions
Method, invert: Public generic functions
Method, invert: Public generic functions
Method, invert: Public generic functions
Method, len: Public generic functions
Method, len: Public generic functions
Method, len: Public generic functions
Method, len: Public generic functions
Method, len: Public generic functions
Method, lookup: Public generic functions
Method, lookup: Public generic functions
Method, lookup: Public generic functions
Method, lookup: Public generic functions
Method, merge-with: Public generic functions
Method, seq?: Public generic functions
Method, seq?: Public generic functions
Method, seq?: Public generic functions
Method, seq?: Public generic functions
Method, seq?: Public generic functions
Method, union: Public generic functions
Method, union: Public generic functions
Method, update: Public generic functions

S
seq-types: Private ordinary functions
seq?: Public generic functions
seq?: Public generic functions
seq?: Public generic functions
seq?: Public generic functions
seq?: Public generic functions
seq?: Public generic functions
set-literal-reader: Private ordinary functions
set-type?: Private ordinary functions
set?: Public ordinary functions
string-template-reader: Private ordinary functions

U
union: Public generic functions
union: Public generic functions
union: Public generic functions
update: Public generic functions
update: Public generic functions

W
walk: Public ordinary functions
when-let: Public macros

Jump to:   =   ~  
A   C   D   E   F   G   I   K   L   M   S   U   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*type*: Private special variables

S
Special Variable, *type*: Private special variables

Jump to:   *  
S