The deoxybyte-utilities Reference Manual

4.1.1 deoxybyte-utilities/deoxybyte-utilities.asd

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (system).

ASDF Systems

deoxybyte-utilities.

---

4.1.2 deoxybyte-utilities/deoxybyte-utilities/package.lisp

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Packages

uk.co.deoxybyte-utilities.

---

4.1.3 deoxybyte-utilities/deoxybyte-utilities/conditions.lisp

Dependency

package.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• deprecation-warning (condition).
• formatted-condition (condition).
• invalid-argument-error (condition).
• invalid-operation-error (condition).
• message-of (generic function).
• missing-argument-error (condition).
• simple-text-condition (condition).

Internals

• arguments-of (reader method).
• feature-of (reader method).
• format-arguments-of (reader method).
• format-control-of (reader method).
• in-favour-of (reader method).
• parameters-of (reader method).
• parameters-of (reader method).
• text-of (reader method).

---

4.1.4 deoxybyte-utilities/deoxybyte-utilities/type-utilities.lisp

Dependency

conditions.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• array-index (type).
• int16 (type).
• int32 (type).
• int8 (type).
• nibble (type).
• octet (type).
• simple-octet-vector (type).
• uint16 (type).
• uint32 (type).
• uint8 (type).
• vector-index (type).

---

4.1.5 deoxybyte-utilities/deoxybyte-utilities/deoxybyte-utilities.lisp

Dependency

type-utilities.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• check-arguments (macro).
• collect (function).
• consume (function).
• copy-vector (macro).
• current (function).
• defgenerator (macro).
• discard (function).
• discarding-if (function).
• funcall-if-fn (macro).
• has-more-p (function).
• next (function).
• with-gensyms (macro).

---

4.1.6 deoxybyte-utilities/deoxybyte-utilities/numeric-utilities.lisp

Dependency

deoxybyte-utilities.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• define-categorical-binner (macro).
• iota (function).
• number-generator (function).
• with-numeric-selector (macro).

Internals

quotedp (function).

---

4.1.7 deoxybyte-utilities/deoxybyte-utilities/cons-utilities.lisp

Dependency

numeric-utilities.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• assocdr (macro).
• assocpop (macro).
• assocpush (macro).
• collect-key-values (function).
• dotted-pair-p (function).
• exactly-n (function).
• exactly-one (function).
• flatten (function).
• intersperse (function).
• key-value (function).
• modify-key-value (function).
• nsplice (function).
• proper-list-p (function).
• rassocar (macro).
• remove-key-values (function).
• rplassoc (macro).
• splice (function).

Internals

canonical-fn-args (function).

---

4.1.8 deoxybyte-utilities/deoxybyte-utilities/set-utilities.lisp

Dependency

cons-utilities.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• linear-intersection (function).
• linear-set-difference (function).
• linear-set-equal (function).
• linear-set-exclusive-or (function).
• linear-subsetp (function).
• linear-union (function).

---

4.1.9 deoxybyte-utilities/deoxybyte-utilities/vector-utilities.lisp

Dependency

set-utilities.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• binary-search (function).
• vector-positions (function).
• vector-split (function).
• vector-split-indices (function).

---

4.1.10 deoxybyte-utilities/deoxybyte-utilities/string-utilities.lisp

Dependency

vector-utilities.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• concat-strings (function).
• contains-char-p (function).
• content-string-p (function).
• control-char-p (function).
• empty-string-p (function).
• ends-with-char-p (function).
• ends-with-string-p (function).
• every-char-p (function).
• has-char-at-p (function).
• starts-with-char-p (function).
• starts-with-string-p (function).
• str (function).
• string-positions (function).
• string-split (function).
• string-split-indices (function).
• txt (function).
• whitespace-char-p (function).
• whitespace-string-p (function).

Internals

*whitespace-chars* (special variable).

---

4.1.11 deoxybyte-utilities/deoxybyte-utilities/octet-vector-utilities.lisp

Dependency

string-utilities.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• octets-to-string (function).
• string-to-octets (function).

---

4.1.12 deoxybyte-utilities/deoxybyte-utilities/clos-utilities.lisp

Dependency

octet-vector-utilities.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• all-classes (function).
• all-external-classes (function).
• all-external-generic-functions (function).

---

4.1.13 deoxybyte-utilities/deoxybyte-utilities/finite-state-machine.lisp

Dependency

clos-utilities.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• defsm (macro).
• defsmfun (macro).

Internals

make-conditional (function).

---

4.1.14 deoxybyte-utilities/deoxybyte-utilities/queue.lisp

Dependency

finite-state-machine.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• make-queue (function).
• queue (structure).
• queue-append (function).
• queue-clear (function).
• queue-delete (function).
• queue-dequeue (function).
• queue-dequeue-if (function).
• queue-empty-p (function).
• queue-enqueue (function).
• queue-first (function).
• queue-head (reader).
• (setf queue-head) (writer).
• queue-last (function).
• queue-nth (function).
• queue-p (function).

Internals

• copy-queue (function).
• queue-length (function).
• queue-position (function).
• queue-tail (reader).
• (setf queue-tail) (writer).

---

4.1.15 deoxybyte-utilities/deoxybyte-utilities/sbcl.lisp

Dependency

queue.lisp (file).

Source

deoxybyte-utilities.asd.

Parent Component

deoxybyte-utilities (module).

Public Interface

• all-slots (function).
• all-specialized-generic-functions (function).
• all-specialized-methods (function).
• all-superclasses (function).
• direct-subclasses (function).
• direct-superclasses (function).
• has-superclass-p (function).
• slot-documentation (function).

Internals

all-slot-definitions (function).

---

6.1.1 Macros

Macro: assocdr (key alist &rest args) ¶

Returns the cdr of the cons cell returned by calling (assoc KEY ALIST ARGS).

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Macro: assocpop (key alist &rest args) ¶

Pops a value from the cdr of the cons returned from ALIST by calling assoc with KEY and ARGS.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Macro: assocpush (key alist val &rest args) ¶

Pushes VAL onto the cdr of the cons returned from ALIST by calling assoc with KEY and ARGS.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Macro: check-arguments (test-form arguments &optional error-message &rest message-arguments) ¶

Checks the validity of ARGUMENTS. If TEST-FORM returns false an {define-condition invalid-argument-error} is raised. The default error message may be refined with an additional ERROR-MESSAGE.

Arguments:

- test-form (form): A form to be evaluated. If the form returns NIL, an error is raised.
- arguments (list symbols): A list of symbols to which argument values are bound.

Optional:

- error-message (string): An error message string.

Rest:

- message-arguments (forms): Forms that evaluate to arguments for the error message.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Macro: copy-vector (source source-start source-end dest dest-start &optional key) ¶

Copies elements SOURCE indices SOURCE-START and SOURCE-END to DEST, inserting them into DEST at DEST-START onwards. If the function KEY is supplied, it is applied to each element of SOURCE prior to its insertion into DEST.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Macro: defgenerator (more-form next-form &optional current-form) ¶

Returns a generator function that may be passed to any of the generator utility functions {defun has-more-p} , {defun next}
and {defun current} .

Arguments:

- more-form (form): A form that returns T if the generator can supply more values, or NIL otherwise. Used by {defun has-more-p } .

- next-form (form): A form that returns the next value of the generator. Used by {defun next} .

Optional:

- current-form (form): A form that returns the current value of the generator. Used by {defun current} .

Returns:
- A form that evaluates to an anonymous function.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Macro: define-categorical-binner (value &rest categories) ¶

Creates a closure that accepts a single fixnum argument. The argument value is assigned to the appropriate bin and that bin’s total is incremented. The closure returns two values, the bins as an array of fixnums and the total number of times values did not fall into any category. Note that the return values are cumulative across calls because the counters are closed over.

Arguments:

- value (symbol): a symbol to which values are bound on the subsequent category forms.

Rest:

- categories (forms): test forms, one for each bin, that evaluate to a generalized boolean. These forms are evaulated in the order given in to assign values to bins.

For example, counting numbers into four bins of odd/positive, odd/negative, even/positive and even/negative.

;;; (define-categorical-binner x
;;; (and (oddp x) (plusp x))
;;; (and (oddp x) (minusp x))
;;; (and (evenp x) (plusp x))
;;; (and (evenp x) (minusp x)))

Returns:

- A closure accepting a numeric value.

Package

uk.co.deoxybyte-utilities.

Source

numeric-utilities.lisp.

Macro: defsm ((&rest states)) ¶

Defines a finite state machine over STATES.

Arguments:

- states (list): A list of forms describing the state transitions. See {defun defsmfun} .

For example:

;;; (let* ((seq (make-dna "atggtgcct"))
;;; (i 0)
;;; (len (length-of seq))
;;; (codons ())
;;; (codon ()))
;;; (defsm ((base0 ((< i len) base1
;;; (setf codon (list (element-of seq i))) ;;; (incf i))
;;; (t nil
;;; (reverse codons)))
;;; (base1 ((< i len) base2
;;; (push (element-of seq i) codon)
;;; (incf i))
;;; (t nil
;;; (reverse codons)))
;;; (base2 ((< i len) base0
;;; (push (element-of seq i) codon)
;;; (push (reverse codon) codons)
;;; (incf i))
;;; (t nil
;;; (reverse codons)))))

Package

uk.co.deoxybyte-utilities.

Source

finite-state-machine.lisp.

Macro: defsmfun (name args bindings (&rest states)) ¶

Returns a function that encapsulates a finite state machine over STATES.

Arguments:

- name (symbol): The name of the function.
- args (lambda list): The function lambda list.
- bindings (list): A list of parallel bindings (as for LET).

Rest:

- states (list): A list of forms describing the state
transitions. Each state form consists of a symbol that denotes a current state and a series of conditional forms that act indicate potential states that may be reached from the current state. The tests are evaluated in turn as in a COND form.

(current-state (test1 next-state1 &rest actions)
(test2 next-state2 &rest actions)
(t nil))

When a test returns T, the machine moves to the next state once the current state’s action forms are evaluated. A next state of NIL indicates termination, at which point the function returns the result of evaluating the last action form.

For example, the following definition returns a function that partitions a DNA sequence into base triples (codons).

;;; (defsmfun codon-iterator (seq &key (start 0))
;;; ((i start)
;;; (len (length-of seq))
;;; (codons ())
;;; (codon ()))
;;; ((base0 ((< i len) base1
;;; (setf codon (list (element-of seq i)))
;;; (incf i))
;;; (t nil
;;; (reverse codons)))
;;; (base1 ((< i len) base2
;;; (push (element-of seq i) codon)
;;; (incf i))
;;; (t nil
;;; (reverse codons)))
;;; (base2 ((< i len) base0
;;; (push (element-of seq i) codon)
;;; (push (reverse codon) codons)
;;; (incf i))
;;; (t nil
;;; (reverse codons)))))

Returns:

- A function.

Package

uk.co.deoxybyte-utilities.

Source

finite-state-machine.lisp.

Macro: funcall-if-fn (function arg) ¶

If FUNCTION is not null, funcalls FUNCTION on ARG, otherwise returns ARG.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Macro: rassocar (val alist &rest args) ¶

Returns the car of the cons cell returned by calling (rassoc KEY ALIST ARGS).

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Macro: rplassoc (key alist val &rest args) ¶

Performs destructive replacement with VAL (using RPLACD) of the cdr of the cons returned when calling assoc on ALIST with KEY and ARGS.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Macro: with-gensyms ((&rest names) &body body) ¶

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Macro: with-numeric-selector ((name num-bins &key start end out-of-bounds) &body body) ¶

Defines a local function NAME that accepts a single fixnum argument and returns an integer between 0 and NUM-BINS, indicating in which of NUM-BINS sequential, equal-sized bins that value belongs.

Arguments:

- name (symbol): the local function name.
- num-bins (integer): the number of bins into which values are to be assigned.

Key:

- start (number): the lower bound of the range of values to be binned, defaults to 0.
- end (number): the upper bound of the range of values to be binned. - oob-error (boolean): if T the function will throw an INVALID-ARGUMENT-ERROR when passed values less than START or greater than END, otherwise the function will return NIL.

Package

uk.co.deoxybyte-utilities.

Source

numeric-utilities.lisp.

---

6.1.2 Ordinary functions

Function: all-classes (package-name &optional superclass) ¶

Returns a list of all classes defined in package PACKAGE-NAME, optionally restricted to those classes that have SUPERCLASS.

Package

uk.co.deoxybyte-utilities.

Source

clos-utilities.lisp.

Function: all-external-classes (package-name &optional superclass) ¶

Returns a list of all exported classes defined in package PACKAGE-NAME, optionally restricted to those classes that have SUPERCLASS.

Package

uk.co.deoxybyte-utilities.

Source

clos-utilities.lisp.

Function: all-external-generic-functions (package-name) ¶

Returns a list of all the external generic functions in package PACKAGE-NAME.

Package

uk.co.deoxybyte-utilities.

Source

clos-utilities.lisp.

Function: all-slots (class) ¶

Returns a sorted list of all slots of CLASS.

Package

uk.co.deoxybyte-utilities.

Source

sbcl.lisp.

Function: all-specialized-generic-functions (class &optional ceiling) ¶

Returns a list of all generic functions specialized on CLASS, up to, but not including, class CEILING. The class CEILING defaults to STANDARD-OBJECT.

Package

uk.co.deoxybyte-utilities.

Source

sbcl.lisp.

Function: all-specialized-methods (class &optional ceiling) ¶

Returns a list of all methods specialized on CLASS, up to, but not including, class CEILING. The class CEILING defaults to STANDARD-OBJECT.

Package

uk.co.deoxybyte-utilities.

Source

sbcl.lisp.

Function: all-superclasses (class &optional ceiling) ¶

Returns a list of all superclasses of CLASS, up to, but not including, class CEILING. The class CEILING defaults to STANDARD-OBJECT.

Package

uk.co.deoxybyte-utilities.

Source

sbcl.lisp.

Function: binary-search (vector item &key test key start end) ¶

Searches for ITEM in VECTOR by binary search.

Arguments:

- vector (vector): A sorted vector to be searched.
- item (object): The item to be found.

Key:

- test (function): The test used to compare ITEM with VECTOR elements. - key (function): A key function with which to transform VECTOR elements. - start (fixnum): The lower bound index of the search in VECTOR.
- end (fixnum): The upper bound index of the search in VECTOR.

Returns:
- An object, or NIL.

Package

uk.co.deoxybyte-utilities.

Source

vector-utilities.lisp.

Function: collect (gen &optional n) ¶

Returns a list of up to N values collected from generator function GEN. Uses {defun has-more-p} to test the generator and may return an empty list if no items are available.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Function: collect-key-values (keywords arg-list) ¶

For all keywords in list KEYWORDS, finds the keyword and its value in ARG-LIST, a list containing only keyword and value pairs. Returns two values, a list of matched keywords and a list of their corresponding values.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: concat-strings (strs) ¶

Returns a new simple-string created by concatenating, in the order supplied, the simple-strings contained in the vector STRS.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: consume (con &rest args) ¶

Applies consumer function CON with arguments ARGS.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Function: contains-char-p (str char &key test) ¶

Returns T if STR contains CHAR, determined by TEST (defaults to CHAR=) or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: content-string-p (str) ¶

Returns T if any of the characters in STR are not whitespace as defined by WHITESPACE-CHAR-P, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: control-char-p (char) ¶

Returns T if CHAR is an ASCII control character (all characters with codes 0-31, inclusive, and the character with code 127), or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: current (gen) ¶

Returns the current value of generator function GEN.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Function: direct-subclasses (class) ¶

Returns a list of the direct subclasses of CLASS.

Package

uk.co.deoxybyte-utilities.

Source

sbcl.lisp.

Function: direct-superclasses (class) ¶

Returns a list of the direct superclasses of CLASS.

Package

uk.co.deoxybyte-utilities.

Source

sbcl.lisp.

Function: discard (gen &optional n) ¶

Discards up to N values collected from generator function GEN. Uses {defun has-more-p} to test the generator and finally returns the number of values actually discarded.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Function: discarding-if (test gen) ¶

Returns a new generator function that discards values from generator function GEN while they satisfy TEST.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Function: dotted-pair-p (list) ¶

Returns T if LIST is a dotted pair, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: empty-string-p (str) ¶

Returns T if STR is a zero-length string or contains only whitespace as defined by WHITESPACE-CHAR-P, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: ends-with-char-p (str char &key test) ¶

Returns T if STR has CHAR at its last index, determined by TEST (defaults to CHAR=), or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: ends-with-string-p (str1 str2 &key test) ¶

Returns T if STR1 ends with STR2, determined by TEST (defaults to STRING=), or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: every-char-p (str test &rest indices) ¶

Applies predicate TEST to characters of string STR indicated by INDICES and returns T if all those characters match TEST.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: exactly-n (predicate n first-seq &rest more-seqs) ¶

Analagous to the ANSI standard functions EVERY and SOME, except that this function returns T if exactly N tests of PREDICATE are true, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: exactly-one (predicate first-seq &rest more-seqs) ¶

Analagous to the ANSI standard functions EVERY and SOME, except that this function returns T if exactly one test of PREDICATE is true, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: flatten (tree) ¶

Returns a new list containing the members of TREE.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: has-char-at-p (str char index &key test) ¶

Returns T if STR has CHAR at INDEX, determined by TEST (defaults to CHAR=), or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: has-more-p (gen) ¶

Returns T if generator function GEN has more available values, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Function: has-superclass-p (class superclass) ¶

Returns T if CLASS has SUPERCLASS, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

sbcl.lisp.

Function: intersperse (list obj) ¶

Returns a list containing the members of LIST interspersed with OBJ.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: iota (count &optional start step) ¶

Generates a list of COUNT integers from START (defaults to 0) with subsequent integers STEP (defaults to 1) greater than the last, or less, if a negative STEP is given.

Package

uk.co.deoxybyte-utilities.

Source

numeric-utilities.lisp.

Function: key-value (keyword arg-list) ¶

Returns the current value of KEYWORD in list ARG-LIST, a list containing only keyword and value pairs.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: linear-intersection (list1 list2 &key key test) ¶

Returns a list that is the intersection of LIST1 and LIST2, in linear time. See CL:INTERSECTION for the meaning of KEY and TEST.

Package

uk.co.deoxybyte-utilities.

Source

set-utilities.lisp.

Function: linear-set-difference (list1 list2 &key key test) ¶

Returns a list that is the set difference of LIST1 and LIST2, in linear time. See CL:SET-DIFFERENCE for the meaning of KEY and TEST.

Package

uk.co.deoxybyte-utilities.

Source

set-utilities.lisp.

Function: linear-set-equal (list1 list2 &key key test) ¶

Package

uk.co.deoxybyte-utilities.

Source

set-utilities.lisp.

Function: linear-set-exclusive-or (list1 list2 &key key test) ¶

Returns a list that is the set exclusive-or of LIST1 and LIST2, in linear time. See CL:SET-EXCLUSIVE-OR for the meaning of KEY and TEST.

Package

uk.co.deoxybyte-utilities.

Source

set-utilities.lisp.

Function: linear-subsetp (list1 list2 &key key test) ¶

Returns T if LIST1 is a subset of LIST2, in linear time. See CL:SUBSETP for the meaning of KEY and TEST.

Package

uk.co.deoxybyte-utilities.

Source

set-utilities.lisp.

Function: linear-union (list1 list2 &key key test) ¶

Returns a list that is the union of LIST1 and LIST2, in linear time. See CL:UNION for the meaning of KEY and TEST.

Package

uk.co.deoxybyte-utilities.

Source

set-utilities.lisp.

Function: make-queue (&key head tail) ¶

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: modify-key-value (keyword arg-list mod-fn &rest fn-args) ¶

Returns a copy of ARG-LIST where the value corresponding to KEYWORD has been replaced by the result of applying MOD-FN to that
value. MOD-FN must be a function that accepts KEYWORDS’s value and may accept additional arguments supplied in FN-ARGS.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: next (gen) ¶

Returns the next available value from generator function GEN.

Package

uk.co.deoxybyte-utilities.

Source

deoxybyte-utilities.lisp.

Function: nsplice (list obj n) ¶

Destructively splices atom or list OBJ into LIST at position N.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: number-generator (&optional start step) ¶

Creates a closure of zero arity that returns an integer from START with subsequent integers incrementing by STEP greater than the last, or less, is a negative step is given.

Optional:

- start (integer): the start value, defaults to 0.
- step (integer): the step size, defaults to 1.

Returns:

- A closure of zero arity.

Package

uk.co.deoxybyte-utilities.

Source

numeric-utilities.lisp.

Function: octets-to-string (octets &optional start end) ¶

Returns a new simple-base-string created from the values in OCTET-VECTOR, a simple-array of (unsigned-byte 8), between indices START and END. The elements of the returned string are the result of calling code-char on the respective elements of OCTET-VECTOR.

Package

uk.co.deoxybyte-utilities.

Source

octet-vector-utilities.lisp.

Function: proper-list-p (list) ¶

Returns T if LIST is a proper list, or NIL otherwise. A proper list is defined as a list whose terminal cdr is NIL. This function does not test the list for circularity.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: queue-append (queue &rest lists) ¶

Inserts LISTS of items at the end of QUEUE and returns QUEUE.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-clear (queue) ¶

Removes all items from queue, returning two values, the queue and a list of all the items that were in the queue.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-delete (item queue &key key test) ¶

Deletes the first occurrence of ITEM in QUEUE, if present, returning QUEUE. The TEST and KEY keyword arguments are the same as for CL:DELETE.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-dequeue (queue) ¶

Removes one item from the front of QUEUE and returns two values. The first value is the item, or NIL if QUEUE was empty and the second value is T if an item was dequeued, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-dequeue-if (test queue &key key) ¶

Removes items from QUEUE that pass predicate TEST, returning two values, QUEUE and a list of the deleted items. The KEY keyword argument is the same as for C:DELETE-IF.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-empty-p (queue) ¶

Returns T if QUEUE is empty, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-enqueue (item queue) ¶

Inserts ITEM at the end of QUEUE and returns QUEUE.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-first (queue) ¶

Returns the first item in QUEUE, without removing it.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Reader: queue-head (instance) ¶

Writer: (setf queue-head) (instance) ¶

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Target Slot

head.

Function: queue-last (queue) ¶

Returns the last item in QUEUE, without removing it.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-nth (n queue) ¶

Returns the Nth item in QUEUE.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-p (object) ¶

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: remove-key-values (keywords arg-list) ¶

Returns two values, a copy of ARG-LIST, a list containing only keyword and value pairs, with KEYWORDS and their values removed and an alist containing KEYWORDS and their corresponding values.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: slot-documentation (slot class) ¶

Returns the documentation string for SLOT of CLASS.

Package

uk.co.deoxybyte-utilities.

Source

sbcl.lisp.

Function: splice (list obj n) ¶

Splices atom or (a copy of) list OBJ into a copy of LIST at position N.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: starts-with-char-p (str char &key test) ¶

Returns T if STR has CHAR at index 0, determined by TEST (defaults to CHAR=), or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: starts-with-string-p (str1 str2 &key test) ¶

Returns T if STR1 starts with STR2, determined by TEST (defaults to STRING=), or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: str (&rest strings) ¶

Returns the result of concatenating strings STRINGS.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: string-positions (str char &key start end) ¶

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: string-split (str char &key start end remove-empty-substrings) ¶

Returns a list of strings made by splitting simple-string STR at CHAR, between START and END. If REMOVE-EMPTY-SUBSEQS is T, any empty subsequences will be omitted from the returned list.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: string-split-indices (str char &key start end) ¶

Returns two values, a list of start indices and a list of end indices into STR between START and END such that if used as start/end arguments to subseq, STR will be split on CHAR. CHAR is compared with elements in STR using TEST, which defaults to EQL.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: string-to-octets (str &optional start end) ¶

Returns a new vector of octets created from the simple-string STR, between indices START and END. The elements of the returned vector are the result of calling char-code on the respective characters of STR.

Package

uk.co.deoxybyte-utilities.

Source

octet-vector-utilities.lisp.

Function: txt (&rest strings) ¶

Returns the result of concatenating STRINGS, separated by spaces.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: vector-positions (elt vector &key start end test) ¶

Returns a list of indices into VECTOR between START and END where ELT is present according to TEST (which defaults to EQL).

Package

uk.co.deoxybyte-utilities.

Source

vector-utilities.lisp.

Function: vector-split (elt vector &key start end test remove-empty-subseqs displace-to-vector) ¶

Returns a list of vectors made by splitting VECTOR at ELT, between START and END. ELT is compared with elements in VECTOR using TEST, which defaults to EQL. If REMOVE-EMPTY-SUBSEQS is T, any empty subsequences will be omitted from the returned list. If DISPLACE-TO-VECTOR id T, the returned subsequences will be displaced to the actual subsequences within VECTOR and will therefore share structure with VECTOR.

Package

uk.co.deoxybyte-utilities.

Source

vector-utilities.lisp.

Function: vector-split-indices (elt vector &key start end test) ¶

Returns two values, a list of start indices and a list of end indices into VECTOR between START and END such that if used as start/end arguments to subseq, VECTOR will be split on ELT. ELT is compared with elements in VECTOR using TEST, which defaults to EQL.

Package

uk.co.deoxybyte-utilities.

Source

vector-utilities.lisp.

Function: whitespace-char-p (char) ¶

Returns T if CHAR is one of the currently bound set of whitespace characters (defaults to #Space #Tab #Return #Linefeed and #FormFeed), or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

Function: whitespace-string-p (str) ¶

Returns T if all the characters in STR are whitespace as defined by WHITESPACE-CHAR-P, or NIL otherwise.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

---

6.1.3 Generic functions

Generic Function: message-of (condition) ¶

Returns the condition message string.

Package

uk.co.deoxybyte-utilities.

Source

conditions.lisp.

Methods

Method: message-of ((condition simple-text-condition)) ¶

Method: message-of ((condition formatted-condition)) ¶

---

6.1.4 Conditions

Condition: deprecation-warning ¶

A warning that is raised when a deprecated feature is used.

Package

uk.co.deoxybyte-utilities.

Source

conditions.lisp.

Direct superclasses

style-warning.

Direct methods

• feature-of.
• in-favour-of.

Direct slots

Slot: feature ¶

Initform

(quote nil)

Initargs

:feature

Readers

feature-of.

Writers

This slot is read-only.

Slot: in-favour ¶

Initform

(quote nil)

Initargs

:in-favour

Readers

in-favour-of.

Writers

This slot is read-only.

Condition: formatted-condition ¶

Package

uk.co.deoxybyte-utilities.

Source

conditions.lisp.

Direct superclasses

condition.

Direct subclasses

• invalid-argument-error.
• invalid-operation-error.
• missing-argument-error.

Direct methods

• format-arguments-of.
• format-control-of.
• message-of.

Direct slots

Slot: format-control ¶

The format control used to create
the condition message.

Initform

(quote nil)

Initargs

:format-control

Readers

format-control-of.

Writers

This slot is read-only.

Slot: format-arguments ¶

The list of format arguments used
to create the condition message.

Initform

(quote nil)

Initargs

:format-arguments

Readers

format-arguments-of.

Writers

This slot is read-only.

Condition: invalid-argument-error ¶

An error that is raised when an invalid argument is passed to a function.

Package

uk.co.deoxybyte-utilities.

Source

conditions.lisp.

Direct superclasses

• error.
• formatted-condition.

Direct methods

• arguments-of.
• parameters-of.

Direct slots

Slot: parameters ¶

The invalid parameters.

Initform

(quote "<not supplied>")

Initargs

:parameters

Readers

parameters-of.

Writers

This slot is read-only.

Slot: arguments ¶

The invalid arguments.

Initform

(quote "<not supplied>")

Initargs

:arguments

Readers

arguments-of.

Writers

This slot is read-only.

Condition: invalid-operation-error ¶

An error that is raised when an invalid operation is attempted.

Package

uk.co.deoxybyte-utilities.

Source

conditions.lisp.

Direct superclasses

• error.
• formatted-condition.

Condition: missing-argument-error ¶

An error that is raised when a required argument is not passed to a function.

Package

uk.co.deoxybyte-utilities.

Source

conditions.lisp.

Direct superclasses

• error.
• formatted-condition.

Direct methods

parameters-of.

Direct slots

Slot: parameters ¶

The invalid parameters.

Initform

(quote "<not supplied>")

Initargs

:parameters

Readers

parameters-of.

Writers

This slot is read-only.

Condition: simple-text-condition ¶

Package

uk.co.deoxybyte-utilities.

Source

conditions.lisp.

Direct superclasses

condition.

Direct methods

• message-of.
• text-of.

Direct slots

Slot: text ¶

Initform

(quote nil)

Initargs

:text

Readers

text-of.

Writers

This slot is read-only.

---

6.1.5 Structures

Structure: queue ¶

A FIFO queue. For consistency, all functions that operate on a QUEUE carry the QUEUE- prefix, even though this results in tautology for some functions, such as QUEUE-ENQUEUE/QUEUE-DEQUEUE. This is a standard way of making a linked-list queue; the QUEUE structure contains pointers to both the head and tail of a single list.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: head ¶

Type

list

Readers

queue-head.

Writers

(setf queue-head).

Slot: tail ¶

Type

list

Readers

queue-tail.

Writers

(setf queue-tail).

---

6.1.6 Types

Type: array-index () ¶

Array index type.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: int16 () ¶

Alias for signed-byte 16.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: int32 () ¶

Alias for signed-byte 32.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: int8 () ¶

Alias for signed-byte 8.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: nibble () ¶

Alias for unsigned-byte 4

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: octet () ¶

Alias for unsigned-byte 8.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: simple-octet-vector () ¶

Alias for (simple-array (unsigned-byte 8) (*)), using a naming convention analagous to simple-base-string.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: uint16 () ¶

Alias for unsigned-byte 16.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: uint32 () ¶

Alias for unsigned-byte 32.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: uint8 () ¶

Alias for unsigned-byte 8.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

Type: vector-index () ¶

Vector index type.

Package

uk.co.deoxybyte-utilities.

Source

type-utilities.lisp.

---

6.2.1 Special variables

Special Variable: *whitespace-chars* ¶

Whitespace characters.

Package

uk.co.deoxybyte-utilities.

Source

string-utilities.lisp.

---

6.2.2 Ordinary functions

Function: all-slot-definitions (class) ¶

Returns a list of all slot definitions of CLASS.

Package

uk.co.deoxybyte-utilities.

Source

sbcl.lisp.

Function: canonical-fn-args (lambda-list fn-args) ¶

Returns a canonical version of FN-ARGS corresponding to LAMBDA-LIST.

Package

uk.co.deoxybyte-utilities.

Source

cons-utilities.lisp.

Function: copy-queue (instance) ¶

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: make-conditional (acceptors) ¶

Package

uk.co.deoxybyte-utilities.

Source

finite-state-machine.lisp.

Function: queue-length (queue) ¶

Returns the length of QUEUE.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Function: queue-position (item queue &key key test) ¶

Returns the zero-based index of ITEM in QUEUE, or NIL if ITEM is not present. The TEST and KEY keyword arguments are the same as for CL:POSITION.

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Reader: queue-tail (instance) ¶

Writer: (setf queue-tail) (instance) ¶

Package

uk.co.deoxybyte-utilities.

Source

queue.lisp.

Target Slot

tail.

Function: quotedp (form) ¶

Returns T if FORM is quoted.

Package

uk.co.deoxybyte-utilities.

Source

numeric-utilities.lisp.

---

6.2.3 Generic functions

Generic Reader: arguments-of (condition) ¶

Package

uk.co.deoxybyte-utilities.

Methods

Reader Method: arguments-of ((condition invalid-argument-error)) ¶

Source

conditions.lisp.

Target Slot

arguments.

Generic Reader: feature-of (condition) ¶

Package

uk.co.deoxybyte-utilities.

Methods

Reader Method: feature-of ((condition deprecation-warning)) ¶

Source

conditions.lisp.

Target Slot

feature.

Generic Reader: format-arguments-of (condition) ¶

Package

uk.co.deoxybyte-utilities.

Methods

Reader Method: format-arguments-of ((condition formatted-condition)) ¶

Source

conditions.lisp.

Target Slot

format-arguments.

Generic Reader: format-control-of (condition) ¶

Package

uk.co.deoxybyte-utilities.

Methods

Reader Method: format-control-of ((condition formatted-condition)) ¶

Source

conditions.lisp.

Target Slot

format-control.

Generic Reader: in-favour-of (condition) ¶

Package

uk.co.deoxybyte-utilities.

Methods

Reader Method: in-favour-of ((condition deprecation-warning)) ¶

Source

conditions.lisp.

Target Slot

in-favour.

Generic Reader: parameters-of (condition) ¶

Package

uk.co.deoxybyte-utilities.

Methods

Reader Method: parameters-of ((condition missing-argument-error)) ¶

Source

conditions.lisp.

Target Slot

parameters.

Reader Method: parameters-of ((condition invalid-argument-error)) ¶

Source

conditions.lisp.

Target Slot

parameters.

Generic Reader: text-of (condition) ¶

Package

uk.co.deoxybyte-utilities.

Methods

Reader Method: text-of ((condition simple-text-condition)) ¶

Source

conditions.lisp.

Target Slot

text.

---