The cl-oju Reference Manual

This is the cl-oju Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:31:23 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-oju

Common Lisp equivalents of core Clojure functions, especially sequence-related ones

Author

John Jacobsen

License

MIT

Version

0.0.1

Dependency

1am (system).

Source

cl-oju.asd.

Child Component

src (module).


3 Modules

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


3.1 cl-oju/src

Source

cl-oju.asd.

Parent Component

cl-oju (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cl-oju/cl-oju.asd

Source

cl-oju.asd.

Parent Component

cl-oju (system).

ASDF Systems

cl-oju.


4.1.2 cl-oju/src/package.lisp

Source

cl-oju.asd.

Parent Component

src (module).

Packages

cl-oju.


4.1.3 cl-oju/src/main.lisp

Dependency

package.lisp (file).

Source

cl-oju.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 cl-oju

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: comment (&rest ign)
Package

cl-oju.

Source

main.lisp.

Macro: if-not (pred then &optional else)
Package

cl-oju.

Source

main.lisp.

Macro: when-not (pred &rest body)
Package

cl-oju.

Source

main.lisp.


6.1.2 Ordinary functions

Function: comp (&rest fns)
Package

cl-oju.

Source

main.lisp.

Function: drop (n l)
Package

cl-oju.

Source

main.lisp.

Function: filter (f l)
Package

cl-oju.

Source

main.lisp.

Function: frequencies (lst)
Package

cl-oju.

Source

main.lisp.

Function: group-by (fn coll)
Package

cl-oju.

Source

main.lisp.

Function: interleave (lst1 lst2)
Package

cl-oju.

Source

main.lisp.

Function: interpose (sep coll)
Package

cl-oju.

Source

main.lisp.

Function: juxt (&rest fs)
Package

cl-oju.

Source

main.lisp.

Function: neg? (n)
Package

cl-oju.

Source

main.lisp.

Function: not= (a b)
Package

cl-oju.

Source

main.lisp.

Function: partial (fun &rest xs)
Package

cl-oju.

Source

main.lisp.

Function: partition-all (cell-size step-size lst)
Package

cl-oju.

Source

main.lisp.

Function: partition-by (f l)
Package

cl-oju.

Source

main.lisp.

Function: partition-n (cell-size step-size lst)
Package

cl-oju.

Source

main.lisp.

Function: pos? (n)
Package

cl-oju.

Source

main.lisp.

Function: rand-int (n)
Package

cl-oju.

Source

main.lisp.

Function: rand-nth (l)
Package

cl-oju.

Source

main.lisp.

Function: range (n &optional m)
Package

cl-oju.

Source

main.lisp.

Function: repeatedly (n f)
Package

cl-oju.

Source

main.lisp.

Function: slurp (infile)
Package

cl-oju.

Source

main.lisp.

Function: sort-by (fn coll)
Package

cl-oju.

Source

main.lisp.

Function: spit (name s)
Package

cl-oju.

Source

main.lisp.

Function: str (&rest args)
Package

cl-oju.

Source

main.lisp.

Function: take (n l)
Package

cl-oju.

Source

main.lisp.

Function: take-while (f l)
Package

cl-oju.

Source

main.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: fast-length (coll)
Package

cl-oju.

Source

main.lisp.


6.2.2 Generic functions

Generic Function: compare< (a b)

Determine whether A is less than B in the appropriate sense.

Package

cl-oju.

Source

main.lisp.

Methods
Method: compare< ((a null) (b null))
Method: compare< ((a null) (b cons))
Method: compare< ((a cons) (b null))
Method: compare< ((a cons) (b cons))
Method: compare< ((a character) (b character))
Method: compare< ((a symbol) (b symbol))
Method: compare< ((a string) (b string))
Method: compare< ((a number) (b number))

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   F   G   I   J   M   N   P   R   S   T   W  
Index Entry  Section

C
comment: Public macros
comp: Public ordinary functions
compare<: Private generic functions
compare<: Private generic functions
compare<: Private generic functions
compare<: Private generic functions
compare<: Private generic functions
compare<: Private generic functions
compare<: Private generic functions
compare<: Private generic functions
compare<: Private generic functions

D
drop: Public ordinary functions

F
fast-length: Private ordinary functions
filter: Public ordinary functions
frequencies: Public ordinary functions
Function, comp: Public ordinary functions
Function, drop: Public ordinary functions
Function, fast-length: Private ordinary functions
Function, filter: Public ordinary functions
Function, frequencies: Public ordinary functions
Function, group-by: Public ordinary functions
Function, interleave: Public ordinary functions
Function, interpose: Public ordinary functions
Function, juxt: Public ordinary functions
Function, neg?: Public ordinary functions
Function, not=: Public ordinary functions
Function, partial: Public ordinary functions
Function, partition-all: Public ordinary functions
Function, partition-by: Public ordinary functions
Function, partition-n: Public ordinary functions
Function, pos?: Public ordinary functions
Function, rand-int: Public ordinary functions
Function, rand-nth: Public ordinary functions
Function, range: Public ordinary functions
Function, repeatedly: Public ordinary functions
Function, slurp: Public ordinary functions
Function, sort-by: Public ordinary functions
Function, spit: Public ordinary functions
Function, str: Public ordinary functions
Function, take: Public ordinary functions
Function, take-while: Public ordinary functions

G
Generic Function, compare<: Private generic functions
group-by: Public ordinary functions

I
if-not: Public macros
interleave: Public ordinary functions
interpose: Public ordinary functions

J
juxt: Public ordinary functions

M
Macro, comment: Public macros
Macro, if-not: Public macros
Macro, when-not: Public macros
Method, compare<: Private generic functions
Method, compare<: Private generic functions
Method, compare<: Private generic functions
Method, compare<: Private generic functions
Method, compare<: Private generic functions
Method, compare<: Private generic functions
Method, compare<: Private generic functions
Method, compare<: Private generic functions

N
neg?: Public ordinary functions
not=: Public ordinary functions

P
partial: Public ordinary functions
partition-all: Public ordinary functions
partition-by: Public ordinary functions
partition-n: Public ordinary functions
pos?: Public ordinary functions

R
rand-int: Public ordinary functions
rand-nth: Public ordinary functions
range: Public ordinary functions
repeatedly: Public ordinary functions

S
slurp: Public ordinary functions
sort-by: Public ordinary functions
spit: Public ordinary functions
str: Public ordinary functions

T
take: Public ordinary functions
take-while: Public ordinary functions

W
when-not: Public macros


A.3 Variables