The gt Reference Manual

This is the gt Reference Manual, version 0.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 17:29:18 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 gt

GrammaTech utilities.

Author

GrammaTech

License

MIT

Version

0.0.0

Defsystem Dependency

asdf-package-system (system).

Dependency

gt/gt (system).

Source

gt.asd.


2.2 gt/gt

Author

GrammaTech

License

MIT

Dependencies
  • alexandria (system).
  • serapeum (system).
  • closer-mop (system).
  • trivia (system).
  • cl-ppcre (system).
  • trivia.ppcre (system).
  • iterate (system).
  • gt/fset (system).
  • fset (system).
  • misc-extensions (system).
  • split-sequence (system).
  • bordeaux-threads (system).
  • functional-trees (system).
  • named-readtables (system).
  • curry-compose-reader-macros (system).
Source

gt.asd.


2.3 gt/fset

Author

GrammaTech

License

MIT

Dependencies
  • fset (system).
  • alexandria (system).
Source

gt.asd.


3 Files

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


3.1 Lisp


3.1.1 gt/gt.asd

Source

gt.asd.

Parent Component

gt (system).

ASDF Systems

3.1.2 gt/gt/file-type.lisp

Source

gt.asd.

Parent Component

gt/gt (system).

Packages

gt.

Public Interface
Internals

3.1.3 gt/fset/file-type.lisp

Source

gt.asd.

Parent Component

gt/fset (system).

Packages

gt/fset.

Public Interface

4 Packages

Packages are listed by definition order.


4.1 gt/fset

Source

file-type.lisp.

Use List

common-lisp.

Used By List

gt.

Public Interface

4.2 gt

Source

file-type.lisp.

Nickname

gt/gt

Use List
  • alexandria.
  • bordeaux-threads.
  • cl-ppcre.
  • closer-mop.
  • common-lisp.
  • curry-compose-reader-macros.
  • editor-hints.named-readtables.
  • fset.
  • functional-trees.
  • gmap.
  • gt/fset.
  • iterate.
  • serapeum.
  • split-sequence.
  • trivia.level2.
  • trivia.ppcre.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: infinity

Most positive number.

Package

gt.

Source

file-type.lisp.

Special Variable: negative-infinity

Most negative number.

Package

gt.

Source

file-type.lisp.

Special Variable: positive-infinity

Most positive number.

Package

gt.

Source

file-type.lisp.


5.1.2 Macros

Macro: defmethod (name &body body)

Like ‘c2mop:defmethod’, but always warn if there is no generic function.

Package

gt.

Source

file-type.lisp.

Macro: lessf (place &rest item-or-tuple)

Modify macro for ‘fset:less’.

Package

gt.

Source

file-type.lisp.

Macro: map-collect (k v &rest args)
Package

gt.

Source

file-type.lisp.

Macro: with-thread-name ((&key name) &body body)

Run BODY with NAME appended to the name of the current thread. This makes it easy to see which thread is doing what in thread listings (and, if the Lisp supports it, with external utilities like ‘top’).

Package

gt.

Source

file-type.lisp.

Macro: withf (place &rest item-or-tuple)

Modify macro for ‘fset:with’.

Package

gt.

Source

file-type.lisp.


5.1.3 Ordinary functions

Function: parse-numbers (string &key radix delim)
Package

gt.

Source

file-type.lisp.


5.1.4 Generic functions

Generic Function: equal? (a b)

Generic equality designed to descend into structures.

Package

gt.

Source

file-type.lisp.

Methods
Method: equal? :around (a b)
Method: equal? (a b)
Method: equal? ((a number) (b number))
Method: equal? ((a character) (b character))
Method: equal? ((a string) (b string))
Method: equal? :around ((a collection) (b collection))
Method: equal? ((a collection) (b collection))
Method: equal? ((a seq) (b seq))
Method: equal? ((a set) (b set))
Method: equal? ((a map) (b map))
Method: equal? ((a bag) (b bag))
Method: equal? ((a tuple) (b tuple))
Method: equal? ((a sequence) (b sequence))
Method: equal? ((a cons) (b cons))
Method: equal? ((a array) (b array))
Method: equal? ((a hash-table) (b hash-table))
Method: equal? ((a standard-object) (b standard-object))
Generic Function: intersection (collection-1 collection-2 &key key test test-not)

Return the intersection of LIST1 and LIST2.

Package

gt/fset.

Source

file-type.lisp.

Methods
Method: intersection ((collection-1 list) (collection-2 list) &rest args &key key test test-not)
Method: intersection ((collection-1 collection) (collection-2 collection) &key key test test-not)
Generic Function: last (collection &optional n)

Return the last N conses (not the last element!) of a list.

Package

gt/fset.

Source

file-type.lisp.

Methods
Method: last ((collection null) &optional n)
Method: last ((collection cons) &optional n)
Method: last ((collection collection) &optional n)
Generic Function: lastcar (collection)

Returns the last element of LIST. Signals a type-error if LIST is not a proper list.

Package

gt/fset.

Source

file-type.lisp.

Methods
Method: lastcar ((collection null))
Method: lastcar ((collection cons))
Method: lastcar ((collection collection))
Generic Function: lines (thing &key &allow-other-keys)

A list of lines in THING.

Package

gt.

Source

file-type.lisp.

Methods
Method: lines ((string string) &rest args &key)
Generic Function: mapconcat (function collection separator &key stream)

Build a string by mapping FUNCTION over COLLECTION.
Separate each value with SEPARATOR.
An extension of ‘serapeum:mapconcat’ to include fset collections.

Package

gt.

Source

file-type.lisp.

Methods
Method: mapconcat (function (sequence sequence) separator &key stream)
Method: mapconcat (function (seq seq) separator &key stream)
Generic Function: set-difference (collection-1 collection-2 &key key test test-not)

Return the elements of LIST1 which are not in LIST2.

Package

gt/fset.

Source

file-type.lisp.

Methods
Method: set-difference ((collection-1 list) (collection-2 list) &rest args &key key test test-not)
Method: set-difference ((collection-1 collection) (collection-2 collection) &key key test test-not)
Generic Function: union (collection-1 collection-2 &key key test test-not)

Return the union of LIST1 and LIST2.

Package

gt/fset.

Source

file-type.lisp.

Methods
Method: union ((collection-1 list) (collection-2 list) &rest args &key key test test-not)
Method: union ((collection-1 collection) (collection-2 collection) &key key test test-not)

5.1.5 Conditions

Condition: parse-number
Package

org.mapcar.parse-number.

Source

file-type.lisp.

Direct superclasses

error.

Direct methods

text.

Direct slots
Slot: text
Package

gt.

Initform

(quote nil)

Initargs

:text

Readers

text.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Macros

Macro: clause-%map-collect-12 (&key %map-collect into)
Package

gt.

Source

file-type.lisp.

Macro: clause-for-in-bag-8 (&key for in-bag generate)

Driver for FSet bags.

Package

gt.

Source

file-type.lisp.

Macro: clause-for-in-bag-pairs-9 (&key for in-bag-pairs generate)

Driver for FSet bags.

Package

gt.

Source

file-type.lisp.

Macro: clause-for-in-iterator-3 (&key for in-iterator generate)

Driver for FSet iterators.

Package

gt.

Source

file-type.lisp.

Macro: clause-for-in-map-7 (&key for in-map generate)

Driver for FSet maps. Each key-value pair is returned as a two-element list.

Package

gt.

Source

file-type.lisp.

Macro: clause-for-in-map-iterator-4 (&key for in-map-iterator generate)

Driver for FSet map iterators.

Package

gt.

Source

file-type.lisp.

Macro: clause-for-in-set-5 (&key for in-set generate)

Driver for FSet sets.

Package

gt.

Source

file-type.lisp.

Macro: clause-for-in-tree-6 (&key for in-tree generate)

Driver for functional trees.

Package

gt.

Source

file-type.lisp.

Macro: clause-seq-collect-11 (&key seq-collect into)
Package

gt.

Source

file-type.lisp.

Macro: clause-set-collect-10 (&key set-collect into)
Package

gt.

Source

file-type.lisp.


5.2.2 Ordinary functions

Function: apply-with (map kv)
Package

gt.

Source

file-type.lisp.

Function: call/thread-name (fn name)
Package

gt.

Source

file-type.lisp.

Function: clause-for-in-seq-1 (&key for in-seq from upfrom downfrom to downto above below by with-index generate)

Elements of anything that implements fset:size and fset:lookup.

Package

gt.

Source

file-type.lisp.

Function: clause-for-index-of-seq-2 (&key for index-of-seq from upfrom downfrom to downto above below by with-index generate)

Indices of anything that implements fset:size and fset:lookup.

Package

gt.

Source

file-type.lisp.

Function: compare/iterator (col1 col2)

Compare two FSet collections, known to be of the same size, using FSet’s iterator protocol.

Package

gt.

Source

file-type.lisp.


5.2.3 Generic functions

Generic Reader: text (condition)
Package

gt.

Methods
Reader Method: text ((condition parse-number))
Source

file-type.lisp.

Target Slot

text.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   D   E   F   G   I   L   M   P   S   T   U   W  
Index Entry  Section

A
apply-with: Private ordinary functions

C
call/thread-name: Private ordinary functions
clause-%map-collect-12: Private macros
clause-for-in-bag-8: Private macros
clause-for-in-bag-pairs-9: Private macros
clause-for-in-iterator-3: Private macros
clause-for-in-map-7: Private macros
clause-for-in-map-iterator-4: Private macros
clause-for-in-seq-1: Private ordinary functions
clause-for-in-set-5: Private macros
clause-for-in-tree-6: Private macros
clause-for-index-of-seq-2: Private ordinary functions
clause-seq-collect-11: Private macros
clause-set-collect-10: Private macros
compare/iterator: Private ordinary functions

D
defmethod: Public macros

E
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions
equal?: Public generic functions

F
Function, apply-with: Private ordinary functions
Function, call/thread-name: Private ordinary functions
Function, clause-for-in-seq-1: Private ordinary functions
Function, clause-for-index-of-seq-2: Private ordinary functions
Function, compare/iterator: Private ordinary functions
Function, parse-numbers: Public ordinary functions

G
Generic Function, equal?: Public generic functions
Generic Function, intersection: Public generic functions
Generic Function, last: Public generic functions
Generic Function, lastcar: Public generic functions
Generic Function, lines: Public generic functions
Generic Function, mapconcat: Public generic functions
Generic Function, set-difference: Public generic functions
Generic Function, text: Private generic functions
Generic Function, union: Public generic functions

I
intersection: Public generic functions
intersection: Public generic functions
intersection: Public generic functions

L
last: Public generic functions
last: Public generic functions
last: Public generic functions
last: Public generic functions
lastcar: Public generic functions
lastcar: Public generic functions
lastcar: Public generic functions
lastcar: Public generic functions
lessf: Public macros
lines: Public generic functions
lines: Public generic functions

M
Macro, clause-%map-collect-12: Private macros
Macro, clause-for-in-bag-8: Private macros
Macro, clause-for-in-bag-pairs-9: Private macros
Macro, clause-for-in-iterator-3: Private macros
Macro, clause-for-in-map-7: Private macros
Macro, clause-for-in-map-iterator-4: Private macros
Macro, clause-for-in-set-5: Private macros
Macro, clause-for-in-tree-6: Private macros
Macro, clause-seq-collect-11: Private macros
Macro, clause-set-collect-10: Private macros
Macro, defmethod: Public macros
Macro, lessf: Public macros
Macro, map-collect: Public macros
Macro, with-thread-name: Public macros
Macro, withf: Public macros
map-collect: Public macros
mapconcat: Public generic functions
mapconcat: Public generic functions
mapconcat: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, equal?: Public generic functions
Method, intersection: Public generic functions
Method, intersection: Public generic functions
Method, last: Public generic functions
Method, last: Public generic functions
Method, last: Public generic functions
Method, lastcar: Public generic functions
Method, lastcar: Public generic functions
Method, lastcar: Public generic functions
Method, lines: Public generic functions
Method, mapconcat: Public generic functions
Method, mapconcat: Public generic functions
Method, set-difference: Public generic functions
Method, set-difference: Public generic functions
Method, text: Private generic functions
Method, union: Public generic functions
Method, union: Public generic functions

P
parse-numbers: Public ordinary functions

S
set-difference: Public generic functions
set-difference: Public generic functions
set-difference: Public generic functions

T
text: Private generic functions
text: Private generic functions

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

W
with-thread-name: Public macros
withf: Public macros