Dash

This manual is for Dash version 2.19.1.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with the Invariant Sections being “GNU General Public License,” and no Front-Cover Texts or Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.

1 Installation

Dash is available on GNU ELPA, GNU-devel ELPA, and MELPA, and can be installed with the standard command package-install (see Package Installation in The GNU Emacs Manual).

M-x package-install RET dash RET: Install the Dash library.

Alternatively, you can just dump dash.el in your load-path somewhere (see Lisp Libraries in The GNU Emacs Manual).

Using in a package
Fontification of special variables
Info symbol lookup

1.1 Using in a package

If you use Dash in your own package, be sure to list it as a dependency in the library’s headers as follows (see Library Headers in The Emacs Lisp Reference Manual).

;; Package-Requires: ((dash "2.19.1"))

1.2 Fontification of special variables

The autoloaded minor mode dash-fontify-mode is provided for optional fontification of anaphoric Dash variables (it, acc, etc.) in Emacs Lisp buffers using search-based Font Lock (see Font Lock in The GNU Emacs Manual). In older Emacs versions which do not dynamically detect macros, the minor mode also fontifies calls to Dash macros.

To automatically enable the minor mode in all Emacs Lisp buffers, just call its autoloaded global counterpart global-dash-fontify-mode, either interactively or from your user-init-file:

(global-dash-fontify-mode)

1.3 Info symbol lookup

While editing Elisp files, you can use C-h S (info-lookup-symbol) to look up Elisp symbols in the relevant Info manuals (see Info Lookup in The GNU Emacs Manual). To enable the same for Dash symbols, use the command dash-register-info-lookup. It can be called directly when needed, or automatically from your user-init-file. For example:

(with-eval-after-load 'info-look
  (dash-register-info-lookup))

2 Functions

This chapter contains reference documentation for the Dash API (Application Programming Interface). The names of all public functions defined in the library are prefixed with a dash character (‘-’).

The library also provides anaphoric macro versions of functions where that makes sense. The names of these macros are prefixed with two dashes (‘--’) instead of one.

For instance, while the function -map applies a function to each element of a list, its anaphoric counterpart --map evaluates a form with the local variable it temporarily bound to the current list element instead.

;; Normal version.
(-map (lambda (n) (* n n)) '(1 2 3 4))
    ⇒ (1 4 9 16)

;; Anaphoric version.
(--map (* it it) '(1 2 3 4))
    ⇒ (1 4 9 16)

The normal version can, of course, also be written as in the following example, which demonstrates the utility of both versions.

(defun my-square (n)
  "Return N multiplied by itself."
  (* n n))

(-map #'my-square '(1 2 3 4))
    ⇒ (1 4 9 16)

Maps
Sublist selection
List to list
Reductions
Unfolding
Predicates
Partitioning
Indexing
Set operations
Other list operations
Tree operations
Threading macros
Binding
Side effects
Destructive operations
Function combinators

2.1 Maps

Functions in this category take a transforming function, which is then applied sequentially to each or selected elements of the input list. The results are collected in order and returned as a new list.

Function: -map (fn list) ¶

Apply fn to each item in list and return the list of results.

This function’s anaphoric counterpart is --map.

(-map (lambda (num) (* num num)) '(1 2 3 4))
    ⇒ (1 4 9 16)

(-map #'1+ '(1 2 3 4))
    ⇒ (2 3 4 5)

(--map (* it it) '(1 2 3 4))
    ⇒ (1 4 9 16)

Function: -map-when (pred rep list) ¶

Use pred to conditionally apply rep to each item in list. Return a copy of list where the items for which pred returns nil are unchanged, and the rest are mapped through the rep function.

Alias: -replace-where

2.2 Sublist selection

Functions returning a sublist of the original list.

Function: -filter (pred list) ¶

Return a new list of the items in list for which pred returns non-nil.

Alias: -select.

This function’s anaphoric counterpart is --filter.

For similar operations, see also -keep (see -keep) and -remove (see -remove).

(-filter (lambda (num) (= 0 (% num 2))) '(1 2 3 4))
    ⇒ (2 4)

(-filter #'natnump '(-2 -1 0 1 2))
    ⇒ (0 1 2)

(--filter (= 0 (% it 2)) '(1 2 3 4))
    ⇒ (2 4)

Function: -remove (pred list) ¶

Return a new list of the items in list for which pred returns nil.

Alias: -reject.

This function’s anaphoric counterpart is --remove.

For similar operations, see also -keep (see -keep) and -filter (see -filter).

(-remove (lambda (num) (= 0 (% num 2))) '(1 2 3 4))
    ⇒ (1 3)

(-remove #'natnump '(-2 -1 0 1 2))
    ⇒ (-2 -1)

(--remove (= 0 (% it 2)) '(1 2 3 4))
    ⇒ (1 3)

Function: -remove-first (pred list) ¶

Remove the first item from list for which pred returns non-nil. This is a non-destructive operation, but only the front of list leading up to the removed item is a copy; the rest is list’s original tail. If no item is removed, then the result is a complete copy.

Alias: -reject-first.

This function’s anaphoric counterpart is --remove-first.

See also -map-first (see -map-first), -remove-item (see -remove-item), and -remove-last (see -remove-last).

(-remove-first #'natnump '(-2 -1 0 1 2))
    ⇒ (-2 -1 1 2)

(-remove-first #'stringp '(1 2 "first" "second"))
    ⇒ (1 2 "second")

(--remove-first (> it 3) '(1 2 3 4 5 6))
    ⇒ (1 2 3 5 6)

Function: -remove-last (pred list) ¶

Remove the last item from list for which pred returns non-nil. The result is a copy of list regardless of whether an element is removed.

Alias: -reject-last.

This function’s anaphoric counterpart is --remove-last.

See also -map-last (see -map-last), -remove-item (see -remove-item), and -remove-first (see -remove-first).

(-remove-last #'natnump '(1 3 5 4 7 8 10 -11))
    ⇒ (1 3 5 4 7 8 -11)

(-remove-last #'stringp '(1 2 "last" "second"))
    ⇒ (1 2 "last")

(--remove-last (> it 3) '(1 2 3 4 5 6 7 8 9 10))
    ⇒ (1 2 3 4 5 6 7 8 9)

Function: -remove-item (item list) ¶

Return a copy of list with all occurrences of item removed. The comparison is done with equal.

(-remove-item 3 '(1 2 3 2 3 4 5 3))
    ⇒ (1 2 2 4 5)

(-remove-item 'foo '(foo bar baz foo))
    ⇒ (bar baz)

(-remove-item "bob" '("alice" "bob" "eve" "bob"))
    ⇒ ("alice" "eve")

Function: -non-nil (list) ¶

Return a copy of list with all nil items removed.

(-non-nil '(nil 1 nil 2 nil nil 3 4 nil 5 nil))
    ⇒ (1 2 3 4 5)

(-non-nil '((nil)))
    ⇒ ((nil))

(-non-nil ())
    ⇒ ()

Function: -slice (list from &optional to step) ¶

Return copy of list, starting from index from to index to.

from or to may be negative. These values are then interpreted modulo the length of the list.

If step is a number, only each STEPth item in the resulting section is returned. Defaults to 1.

(-slice '(1 2 3 4 5) 1)
    ⇒ (2 3 4 5)

(-slice '(1 2 3 4 5) 0 3)
    ⇒ (1 2 3)

(-slice '(1 2 3 4 5 6 7 8 9) 1 -1 2)
    ⇒ (2 4 6 8)

Function: -take (n list) ¶

Return a copy of the first n items in list. Return a copy of list if it contains n items or fewer. Return nil if n is zero or less.

See also: -take-last (see -take-last).

(-take 3 '(1 2 3 4 5))
    ⇒ (1 2 3)

(-take 17 '(1 2 3 4 5))
    ⇒ (1 2 3 4 5)

(-take 0 '(1 2 3 4 5))
    ⇒ ()

Function: -take-last (n list) ¶

Return a copy of the last n items of list in order. Return a copy of list if it contains n items or fewer. Return nil if n is zero or less.

2.3 List to list

Functions returning a modified copy of the input list.

Function: -keep (fn list) ¶

Return a new list of the non-nil results of applying fn to each item in list. Like -filter (see -filter), but returns the non-nil results of fn instead of the corresponding elements of list.

Its anaphoric counterpart is --keep.

(-keep #'cdr '((1 2 3) (4 5) (6)))
    ⇒ ((2 3) (5))

(-keep (lambda (n) (and (> n 3) (* 10 n))) '(1 2 3 4 5 6))
    ⇒ (40 50 60)

(--keep (and (> it 3) (* 10 it)) '(1 2 3 4 5 6))
    ⇒ (40 50 60)

Function: -concat (&rest sequences) ¶

Concatenate all the arguments and make the result a list. The result is a list whose elements are the elements of all the arguments. Each argument may be a list, vector or string.

All arguments except the last argument are copied. The last argument is just used as the tail of the new list.

(-concat '(1))
    ⇒ (1)

(-concat '(1) '(2))
    ⇒ (1 2)

(-concat '(1) '(2 3) '(4))
    ⇒ (1 2 3 4)

Function: -flatten (l) ¶

Take a nested list l and return its contents as a single, flat list.

Note that because nil represents a list of zero elements (an empty list), any mention of nil in l will disappear after flattening. If you need to preserve nils, consider -flatten-n (see -flatten-n) or map them to some unique symbol and then map them back.

Conses of two atoms are considered "terminals", that is, they aren’t flattened further.

2.4 Reductions

Functions reducing lists to a single value (which may also be a list).

Function: -reduce-from (fn init list) ¶

Reduce the function fn across list, starting with init. Return the result of applying fn to init and the first element of list, then applying fn to that result and the second element, etc. If list is empty, return init without calling fn.

This function’s anaphoric counterpart is --reduce-from.

For other folds, see also -reduce (see -reduce) and -reduce-r (see -reduce-r).

(-reduce-from #'- 10 '(1 2 3))
    ⇒ 4

(-reduce-from #'list 10 '(1 2 3))
    ⇒ (((10 1) 2) 3)

(--reduce-from (concat acc " " it) "START" '("a" "b" "c"))
    ⇒ "START a b c"

Function: -reduce-r-from (fn init list) ¶

Reduce the function fn across list in reverse, starting with init. Return the result of applying fn to the last element of list and init, then applying fn to the second-to-last element and the previous result of fn, etc. That is, the first argument of fn is the current element, and its second argument the accumulated value. If list is empty, return init without calling fn.

This function is like -reduce-from (see -reduce-from) but the operation associates from the right rather than left. In other words, it starts from the end of list and flips the arguments to fn. Conceptually, it is like replacing the conses in list with applications of fn, and its last link with init, and evaluating the resulting expression.

This function’s anaphoric counterpart is --reduce-r-from.

For other folds, see also -reduce-r (see -reduce-r) and -reduce (see -reduce).

(-reduce-r-from #'- 10 '(1 2 3))
    ⇒ -8

(-reduce-r-from #'list 10 '(1 2 3))
    ⇒ (1 (2 (3 10)))

(--reduce-r-from (concat it " " acc) "END" '("a" "b" "c"))
    ⇒ "a b c END"

Function: -reduce (fn list) ¶

Reduce the function fn across list. Return the result of applying fn to the first two elements of list, then applying fn to that result and the third element, etc. If list contains a single element, return it without calling fn. If list is empty, return the result of calling fn with no arguments.

This function’s anaphoric counterpart is --reduce.

For other folds, see also -reduce-from (see -reduce-from) and -reduce-r (see -reduce-r).

(-reduce #'- '(1 2 3 4))
    ⇒ -8

(-reduce #'list '(1 2 3 4))
    ⇒ (((1 2) 3) 4)

(--reduce (format "%s-%d" acc it) '(1 2 3))
    ⇒ "1-2-3"

Function: -reduce-r (fn list) ¶

Reduce the function fn across list in reverse. Return the result of applying fn to the last two elements of list, then applying fn to the third-to-last element and the previous result of fn, etc. That is, the first argument of fn is the current element, and its second argument the accumulated value. If list contains a single element, return it without calling fn. If list is empty, return the result of calling fn with no arguments.

This function is like -reduce (see -reduce) but the operation associates from the right rather than left. In other words, it starts from the end of list and flips the arguments to fn. Conceptually, it is like replacing the conses in list with applications of fn, ignoring its last link, and evaluating the resulting expression.

This function’s anaphoric counterpart is --reduce-r.

For other folds, see also -reduce-r-from (see -reduce-r-from) and -reduce (see -reduce).

(-reduce-r #'- '(1 2 3 4))
    ⇒ -2

(-reduce-r #'list '(1 2 3 4))
    ⇒ (1 (2 (3 4)))

(--reduce-r (format "%s-%d" acc it) '(1 2 3))
    ⇒ "3-2-1"

Function: -reductions-from (fn init list) ¶

Return a list of fn’s intermediate reductions across list. That is, a list of the intermediate values of the accumulator when -reduce-from (see -reduce-from) (which see) is called with the same arguments.

This function’s anaphoric counterpart is --reductions-from.

For other folds, see also -reductions (see -reductions) and -reductions-r (see -reductions-r).

(-reductions-from #'max 0 '(2 1 4 3))
    ⇒ (0 2 2 4 4)

(-reductions-from #'* 1 '(1 2 3 4))
    ⇒ (1 1 2 6 24)

(--reductions-from (format "(FN %s %d)" acc it) "INIT" '(1 2 3))
    ⇒ ("INIT" "(FN INIT 1)" "(FN (FN INIT 1) 2)" "(FN (FN (FN INIT 1) 2) 3)")

Function: -reductions-r-from (fn init list) ¶

Return a list of fn’s intermediate reductions across reversed list. That is, a list of the intermediate values of the accumulator when -reduce-r-from (see -reduce-r-from) (which see) is called with the same arguments.

This function’s anaphoric counterpart is --reductions-r-from.

For other folds, see also -reductions (see -reductions) and -reductions-r (see -reductions-r).

(-reductions-r-from #'max 0 '(2 1 4 3))
    ⇒ (4 4 4 3 0)

(-reductions-r-from #'* 1 '(1 2 3 4))
    ⇒ (24 24 12 4 1)

(--reductions-r-from (format "(FN %d %s)" it acc) "INIT" '(1 2 3))
    ⇒ ("(FN 1 (FN 2 (FN 3 INIT)))" "(FN 2 (FN 3 INIT))" "(FN 3 INIT)" "INIT")

Function: -reductions (fn list) ¶

Return a list of fn’s intermediate reductions across list. That is, a list of the intermediate values of the accumulator when -reduce (see -reduce) (which see) is called with the same arguments.

This function’s anaphoric counterpart is --reductions.

For other folds, see also -reductions (see -reductions) and -reductions-r (see -reductions-r).

(-reductions #'+ '(1 2 3 4))
    ⇒ (1 3 6 10)

(-reductions #'* '(1 2 3 4))
    ⇒ (1 2 6 24)

(--reductions (format "(FN %s %d)" acc it) '(1 2 3))
    ⇒ (1 "(FN 1 2)" "(FN (FN 1 2) 3)")

Function: -reductions-r (fn list) ¶

Return a list of fn’s intermediate reductions across reversed list. That is, a list of the intermediate values of the accumulator when -reduce-r (see -reduce-r) (which see) is called with the same arguments.

This function’s anaphoric counterpart is --reductions-r.

For other folds, see also -reductions-r-from (see -reductions-r-from) and -reductions (see -reductions).

(-reductions-r #'+ '(1 2 3 4))
    ⇒ (10 9 7 4)

(-reductions-r #'* '(1 2 3 4))
    ⇒ (24 24 12 4)

(--reductions-r (format "(FN %d %s)" it acc) '(1 2 3))
    ⇒ ("(FN 1 (FN 2 3))" "(FN 2 3)" 3)

Function: -count (pred list) ¶

Counts the number of items in list where (pred item) is non-nil.

(-count 'even? '(1 2 3 4 5))
    ⇒ 2

(--count (< it 4) '(1 2 3 4))
    ⇒ 3

Function: -sum (list) ¶

Return the sum of list.

(-sum ())
    ⇒ 0

(-sum '(1))
    ⇒ 1

(-sum '(1 2 3 4))
    ⇒ 10

Function: -running-sum (list) ¶

Return a list with running sums of items in list. list must be non-empty.

(-running-sum '(1 2 3 4))
    ⇒ (1 3 6 10)

(-running-sum '(1))
    ⇒ (1)

(-running-sum ())
    error→ Wrong type argument: consp, nil

Function: -product (list) ¶

Return the product of list.

(-product ())
    ⇒ 1

(-product '(1))
    ⇒ 1

(-product '(1 2 3 4))
    ⇒ 24

Function: -running-product (list) ¶

Return a list with running products of items in list. list must be non-empty.

(-running-product '(1 2 3 4))
    ⇒ (1 2 6 24)

(-running-product '(1))
    ⇒ (1)

(-running-product ())
    error→ Wrong type argument: consp, nil

Function: -inits (list) ¶

Return all prefixes of list.

(-inits '(1 2 3 4))
    ⇒ (nil (1) (1 2) (1 2 3) (1 2 3 4))

(-inits nil)
    ⇒ (nil)

(-inits '(1))
    ⇒ (nil (1))

Function: -tails (list) ¶

Return all suffixes of list.

(-tails '(1 2 3 4))
    ⇒ ((1 2 3 4) (2 3 4) (3 4) (4) nil)

(-tails nil)
    ⇒ (nil)

(-tails '(1))
    ⇒ ((1) nil)

Function: -common-prefix (&rest lists) ¶

Return the longest common prefix of lists.

(-common-prefix '(1))
    ⇒ (1)

(-common-prefix '(1 2) '(3 4) '(1 2))
    ⇒ ()

(-common-prefix '(1 2) '(1 2 3) '(1 2 3 4))
    ⇒ (1 2)

Function: -common-suffix (&rest lists) ¶

Return the longest common suffix of lists.

(-common-suffix '(1))
    ⇒ (1)

(-common-suffix '(1 2) '(3 4) '(1 2))
    ⇒ ()

(-common-suffix '(1 2 3 4) '(2 3 4) '(3 4))
    ⇒ (3 4)

Function: -min (list) ¶

Return the smallest value from list of numbers or markers.

(-min '(0))
    ⇒ 0

(-min '(3 2 1))
    ⇒ 1

(-min '(1 2 3))
    ⇒ 1

Function: -min-by (comparator list) ¶

Take a comparison function comparator and a list and return the least element of the list by the comparison function.

See also combinator -on (see -on) which can transform the values before comparing them.

(-min-by '> '(4 3 6 1))
    ⇒ 1

(--min-by (> (car it) (car other)) '((1 2 3) (2) (3 2)))
    ⇒ (1 2 3)

(--min-by (> (length it) (length other)) '((1 2 3) (2) (3 2)))
    ⇒ (2)

Function: -max (list) ¶

Return the largest value from list of numbers or markers.

(-max '(0))
    ⇒ 0

(-max '(3 2 1))
    ⇒ 3

(-max '(1 2 3))
    ⇒ 3

Function: -max-by (comparator list) ¶

Take a comparison function comparator and a list and return the greatest element of the list by the comparison function.

See also combinator -on (see -on) which can transform the values before comparing them.

(-max-by '> '(4 3 6 1))
    ⇒ 6

(--max-by (> (car it) (car other)) '((1 2 3) (2) (3 2)))
    ⇒ (3 2)

(--max-by (> (length it) (length other)) '((1 2 3) (2) (3 2)))
    ⇒ (1 2 3)

Function: -frequencies (list) ¶

Count the occurrences of each distinct element of list.

Return an alist of (element . n), where each element occurs n times in list.

The test for equality is done with equal, or with -compare-fn if that is non-nil.

See also -count (see -count) and -group-by (see -group-by).

(-frequencies ())
    ⇒ ()

(-frequencies '(1 2 3 1 2 1))
    ⇒ ((1 . 3) (2 . 2) (3 . 1))

(let ((-compare-fn #'string=)) (-frequencies '(a "a")))
    ⇒ ((a . 2))

2.5 Unfolding

Operations dual to reductions, building lists from a seed value rather than consuming a list to produce a single value.

Function: -iterate (fun init n) ¶

Return a list of iterated applications of fun to init.

This means a list of the form:

(init (fun init) (fun (fun init)) …)

n is the length of the returned list.

(-iterate #'1+ 1 10)
    ⇒ (1 2 3 4 5 6 7 8 9 10)

(-iterate (lambda (x) (+ x x)) 2 5)
    ⇒ (2 4 8 16 32)

(--iterate (* it it) 2 5)
    ⇒ (2 4 16 256 65536)

Function: -unfold (fun seed) ¶

Build a list from seed using fun.

This is "dual" operation to -reduce-r (see -reduce-r): while -reduce-r consumes a list to produce a single value, -unfold (see -unfold) takes a seed value and builds a (potentially infinite!) list.

fun should return nil to stop the generating process, or a cons (a . b), where a will be prepended to the result and b is the new seed.

(-unfold (lambda (x) (unless (= x 0) (cons x (1- x)))) 10)
    ⇒ (10 9 8 7 6 5 4 3 2 1)

(--unfold (when it (cons it (cdr it))) '(1 2 3 4))
    ⇒ ((1 2 3 4) (2 3 4) (3 4) (4))

(--unfold (when it (cons it (butlast it))) '(1 2 3 4))
    ⇒ ((1 2 3 4) (1 2 3) (1 2) (1))

Function: -repeat (n x) ¶

Return a new list of length n with each element being x. Return nil if n is less than 1.

(-repeat 3 :a)
    ⇒ (:a :a :a)

(-repeat 1 :a)
    ⇒ (:a)

(-repeat 0 :a)
    ⇒ ()

Function: -cycle (list) ¶

Return an infinite circular copy of list. The returned list cycles through the elements of list and repeats from the beginning.

(-take 5 (-cycle '(1 2 3)))
    ⇒ (1 2 3 1 2)

(-take 7 (-cycle '(1 "and" 3)))
    ⇒ (1 "and" 3 1 "and" 3 1)

(-zip-lists (-cycle '(3)) '(1 2))
    ⇒ ((3 1) (3 2))

2.6 Predicates

Reductions of one or more lists to a boolean value.

Function: -some (pred list) ¶

Return (pred x) for the first list item where (pred x) is non-nil, else nil.

Alias: -any.

This function’s anaphoric counterpart is --some.

(-some #'stringp '(1 "2" 3))
    ⇒ t

(--some (string-match-p "x" it) '("foo" "axe" "xor"))
    ⇒ 1

(--some (= it-index 3) '(0 1 2))
    ⇒ nil

Function: -every (pred list) ¶

Return non-nil if pred returns non-nil for all items in list. If so, return the last such result of pred. Otherwise, once an item is reached for which pred returns nil, return nil without calling pred on any further list elements.

This function is like -every-p, but on success returns the last non-nil result of pred instead of just t.

This function’s anaphoric counterpart is --every.

(-every #'numberp '(1 2 3))
    ⇒ t

(--every (string-match-p "x" it) '("axe" "xor"))
    ⇒ 0

(--every (= it it-index) '(0 1 3))
    ⇒ nil

Function: -any? (pred list) ¶

Return t if (pred x) is non-nil for any x in list, else nil.

Alias: -any-p, -some?, -some-p

(-any? #'numberp '(nil 0 t))
    ⇒ t

(-any? #'numberp '(nil t t))
    ⇒ nil

(-any? #'null '(1 3 5))
    ⇒ nil

Function: -all? (pred list) ¶

Return t if (pred x) is non-nil for all x in list, else nil. In the latter case, stop after the first x for which (pred x) is nil, without calling pred on any subsequent elements of list.

The similar function -every (see -every) is more widely useful, since it returns the last non-nil result of pred instead of just t on success.

Alias: -all-p, -every-p, -every?.

This function’s anaphoric counterpart is --all?.

(-all? #'numberp '(1 2 3))
    ⇒ t

(-all? #'numberp '(2 t 6))
    ⇒ nil

(--all? (= 0 (% it 2)) '(2 4 6))
    ⇒ t

Function: -none? (pred list) ¶

Return t if (pred x) is nil for all x in list, else nil.

Alias: -none-p

(-none? 'even? '(1 2 3))
    ⇒ nil

(-none? 'even? '(1 3 5))
    ⇒ t

(--none? (= 0 (% it 2)) '(1 2 3))
    ⇒ nil

Function: -only-some? (pred list) ¶

Return t if different list items both satisfy and do not satisfy pred. That is, if pred returns both nil for at least one item, and non-nil for at least one other item in list. Return nil if all items satisfy the predicate or none of them do.

Alias: -only-some-p

(-only-some? 'even? '(1 2 3))
    ⇒ t

(-only-some? 'even? '(1 3 5))
    ⇒ nil

(-only-some? 'even? '(2 4 6))
    ⇒ nil

Function: -contains? (list element) ¶

Return non-nil if list contains element.

The test for equality is done with equal, or with -compare-fn if that is non-nil. As with member, the return value is actually the tail of list whose car is element.

Alias: -contains-p.

(-contains? '(1 2 3) 1)
    ⇒ (1 2 3)

(-contains? '(1 2 3) 2)
    ⇒ (2 3)

(-contains? '(1 2 3) 4)
    ⇒ ()

Function: -is-prefix? (prefix list) ¶

Return non-nil if prefix is a prefix of list.

Alias: -is-prefix-p.

(-is-prefix? '(1 2 3) '(1 2 3 4 5))
    ⇒ t

(-is-prefix? '(1 2 3 4 5) '(1 2 3))
    ⇒ nil

(-is-prefix? '(1 3) '(1 2 3 4 5))
    ⇒ nil

Function: -is-suffix? (suffix list) ¶

Return non-nil if suffix is a suffix of list.

Alias: -is-suffix-p.

(-is-suffix? '(3 4 5) '(1 2 3 4 5))
    ⇒ t

(-is-suffix? '(1 2 3 4 5) '(3 4 5))
    ⇒ nil

(-is-suffix? '(3 5) '(1 2 3 4 5))
    ⇒ nil

Function: -is-infix? (infix list) ¶

Return non-nil if infix is infix of list.

This operation runs in o(n^2) time

Alias: -is-infix-p

(-is-infix? '(1 2 3) '(1 2 3 4 5))
    ⇒ t

(-is-infix? '(2 3 4) '(1 2 3 4 5))
    ⇒ t

(-is-infix? '(3 4 5) '(1 2 3 4 5))
    ⇒ t

Function: -cons-pair? (obj) ¶

Return non-nil if obj is a true cons pair. That is, a cons (a . b) where b is not a list.

Alias: -cons-pair-p.

(-cons-pair? '(1 . 2))
    ⇒ t

(-cons-pair? '(1 2))
    ⇒ nil

(-cons-pair? '(1))
    ⇒ nil

2.7 Partitioning

Functions partitioning the input list into a list of lists.

Function: -split-at (n list) ¶

Split list into two sublists after the Nth element. The result is a list of two elements (take drop) where take is a new list of the first n elements of list, and drop is the remaining elements of list (not a copy). take and drop are like the results of -take (see -take) and -drop (see -drop), respectively, but the split is done in a single list traversal.

(-split-at 3 '(1 2 3 4 5))
    ⇒ ((1 2 3) (4 5))

(-split-at 17 '(1 2 3 4 5))
    ⇒ ((1 2 3 4 5) nil)

(-split-at 0 '(1 2 3 4 5))
    ⇒ (nil (1 2 3 4 5))

Function: -split-with (pred list) ¶

Split list into a prefix satisfying pred, and the rest. The first sublist is the prefix of list with successive elements satisfying pred, and the second sublist is the remaining elements that do not. The result is like performing

((-take-while pred list) (-drop-while pred list))

but in no more than a single pass through list.

(-split-with 'even? '(1 2 3 4))
    ⇒ (nil (1 2 3 4))

(-split-with 'even? '(2 4 5 6))
    ⇒ ((2 4) (5 6))

(--split-with (< it 4) '(1 2 3 4 3 2 1))
    ⇒ ((1 2 3) (4 3 2 1))

Macro: -split-on (item list) ¶

Split the list each time item is found.

Unlike -partition-by (see -partition-by), the item is discarded from the results. Empty lists are also removed from the result.

Comparison is done by equal.

See also -split-when (see -split-when)

(-split-on '| '(Nil | Leaf a | Node [Tree a]))
    ⇒ ((Nil) (Leaf a) (Node [Tree a]))

(-split-on :endgroup '("a" "b" :endgroup "c" :endgroup "d" "e"))
    ⇒ (("a" "b") ("c") ("d" "e"))

(-split-on :endgroup '("a" "b" :endgroup :endgroup "d" "e"))
    ⇒ (("a" "b") ("d" "e"))

Function: -split-when (fn list) ¶

Split the list on each element where fn returns non-nil.

Unlike -partition-by (see -partition-by), the "matched" element is discarded from the results. Empty lists are also removed from the result.

This function can be thought of as a generalization of split-string.

(-split-when 'even? '(1 2 3 4 5 6))
    ⇒ ((1) (3) (5))

(-split-when 'even? '(1 2 3 4 6 8 9))
    ⇒ ((1) (3) (9))

(--split-when (memq it '(&optional &rest)) '(a b &optional c d &rest args))
    ⇒ ((a b) (c d) (args))

Function: -separate (pred list) ¶

Split list into two sublists based on whether items satisfy pred. The result is like performing

((-filter pred list) (-remove pred list))

but in a single pass through list.

(-separate (lambda (num) (= 0 (% num 2))) '(1 2 3 4 5 6 7))
    ⇒ ((2 4 6) (1 3 5 7))

(--separate (< it 5) '(3 7 5 9 3 2 1 4 6))
    ⇒ ((3 3 2 1 4) (7 5 9 6))

(-separate 'cdr '((1 2) (1) (1 2 3) (4)))
    ⇒ (((1 2) (1 2 3)) ((1) (4)))

Function: -partition (n list) ¶

Return a new list with the items in list grouped into n-sized sublists. If there are not enough items to make the last group n-sized, those items are discarded.

(-partition 2 '(1 2 3 4 5 6))
    ⇒ ((1 2) (3 4) (5 6))

(-partition 2 '(1 2 3 4 5 6 7))
    ⇒ ((1 2) (3 4) (5 6))

(-partition 3 '(1 2 3 4 5 6 7))
    ⇒ ((1 2 3) (4 5 6))

Function: -partition-all (n list) ¶

Return a new list with the items in list grouped into n-sized sublists. The last group may contain less than n items.

(-partition-all 2 '(1 2 3 4 5 6))
    ⇒ ((1 2) (3 4) (5 6))

(-partition-all 2 '(1 2 3 4 5 6 7))
    ⇒ ((1 2) (3 4) (5 6) (7))

(-partition-all 3 '(1 2 3 4 5 6 7))
    ⇒ ((1 2 3) (4 5 6) (7))

Function: -partition-in-steps (n step list) ¶

Partition list into sublists of length n that are step items apart. Like -partition-all-in-steps (see -partition-all-in-steps), but if there are not enough items to make the last group n-sized, those items are discarded.

(-partition-in-steps 2 1 '(1 2 3 4))
    ⇒ ((1 2) (2 3) (3 4))

(-partition-in-steps 3 2 '(1 2 3 4))
    ⇒ ((1 2 3))

(-partition-in-steps 3 2 '(1 2 3 4 5))
    ⇒ ((1 2 3) (3 4 5))

Function: -partition-all-in-steps (n step list) ¶

Partition list into sublists of length n that are step items apart. Adjacent groups may overlap if n exceeds the step stride. Trailing groups may contain less than n items.

(-partition-all-in-steps 2 1 '(1 2 3 4))
    ⇒ ((1 2) (2 3) (3 4) (4))

(-partition-all-in-steps 3 2 '(1 2 3 4))
    ⇒ ((1 2 3) (3 4))

(-partition-all-in-steps 3 2 '(1 2 3 4 5))
    ⇒ ((1 2 3) (3 4 5) (5))

Function: -partition-by (fn list) ¶

Apply fn to each item in list, splitting it each time fn returns a new value.

(-partition-by 'even? ())
    ⇒ ()

(-partition-by 'even? '(1 1 2 2 2 3 4 6 8))
    ⇒ ((1 1) (2 2 2) (3) (4 6 8))

(--partition-by (< it 3) '(1 2 3 4 3 2 1))
    ⇒ ((1 2) (3 4 3) (2 1))

Function: -partition-by-header (fn list) ¶

Apply fn to the first item in list. That is the header value. Apply fn to each item in list, splitting it each time fn returns the header value, but only after seeing at least one other value (the body).

(--partition-by-header (= it 1) '(1 2 3 1 2 1 2 3 4))
    ⇒ ((1 2 3) (1 2) (1 2 3 4))

(--partition-by-header (> it 0) '(1 2 0 1 0 1 2 3 0))
    ⇒ ((1 2 0) (1 0) (1 2 3 0))

(-partition-by-header 'even? '(2 1 1 1 4 1 3 5 6 6 1))
    ⇒ ((2 1 1 1) (4 1 3 5) (6 6 1))

Function: -partition-after-pred (pred list) ¶

Partition list after each element for which pred returns non-nil.

This function’s anaphoric counterpart is --partition-after-pred.

(-partition-after-pred #'booleanp ())
    ⇒ ()

(-partition-after-pred #'booleanp '(t t))
    ⇒ ((t) (t))

(-partition-after-pred #'booleanp '(0 0 t t 0 t))
    ⇒ ((0 0 t) (t) (0 t))

Function: -partition-before-pred (pred list) ¶

Partition directly before each time pred is true on an element of list.

(-partition-before-pred #'booleanp ())
    ⇒ ()

(-partition-before-pred #'booleanp '(0 t))
    ⇒ ((0) (t))

(-partition-before-pred #'booleanp '(0 0 t 0 t t))
    ⇒ ((0 0) (t 0) (t) (t))

Function: -partition-before-item (item list) ¶

Partition directly before each time item appears in list.

(-partition-before-item 3 ())
    ⇒ ()

(-partition-before-item 3 '(1))
    ⇒ ((1))

(-partition-before-item 3 '(3))
    ⇒ ((3))

Function: -partition-after-item (item list) ¶

Partition directly after each time item appears in list.

(-partition-after-item 3 ())
    ⇒ ()

(-partition-after-item 3 '(1))
    ⇒ ((1))

(-partition-after-item 3 '(3))
    ⇒ ((3))

Function: -group-by (fn list) ¶

Separate list into an alist whose keys are fn applied to the elements of list. Keys are compared by equal.

(-group-by 'even? ())
    ⇒ ()

(-group-by 'even? '(1 1 2 2 2 3 4 6 8))
    ⇒ ((nil 1 1 3) (t 2 2 2 4 6 8))

(--group-by (car (split-string it "/")) '("a/b" "c/d" "a/e"))
    ⇒ (("a" "a/b" "a/e") ("c" "c/d"))

2.8 Indexing

Functions retrieving or sorting based on list indices and related predicates.

Function: -elem-index (elem list) ¶

Return the first index of elem in list. That is, the index within list of the first element that is equal to elem. Return nil if there is no such element.

See also: -find-index (see -find-index).

(-elem-index 2 '(6 7 8 3 4))
    ⇒ nil

(-elem-index "bar" '("foo" "bar" "baz"))
    ⇒ 1

(-elem-index '(1 2) '((3) (5 6) (1 2) nil))
    ⇒ 2

Function: -elem-indices (elem list) ¶

Return the list of indices at which elem appears in list. That is, the indices of all elements of list equal to elem, in the same ascending order as they appear in list.

(-elem-indices 2 '(6 7 8 3 4 1))
    ⇒ ()

(-elem-indices "bar" '("foo" "bar" "baz"))
    ⇒ (1)

(-elem-indices '(1 2) '((3) (1 2) (5 6) (1 2) nil))
    ⇒ (1 3)

Function: -find-index (pred list) ¶

Return the index of the first item satisfying pred in list. Return nil if no such item is found.

pred is called with one argument, the current list element, until it returns non-nil, at which point the search terminates.

This function’s anaphoric counterpart is --find-index.

See also: -first (see -first), -find-last-index (see -find-last-index).

(-find-index #'numberp '(a b c))
    ⇒ nil

(-find-index #'natnump '(1 0 -1))
    ⇒ 0

(--find-index (> it 5) '(2 4 1 6 3 3 5 8))
    ⇒ 3

Function: -find-last-index (pred list) ¶

Return the index of the last item satisfying pred in list. Return nil if no such item is found.

Predicate pred is called with one argument each time, namely the current list element.

This function’s anaphoric counterpart is --find-last-index.

See also: -last (see -last), -find-index (see -find-index).

(-find-last-index #'numberp '(a b c))
    ⇒ nil

(--find-last-index (> it 5) '(2 7 1 6 3 8 5 2))
    ⇒ 5

(-find-last-index (-partial #'string< 'a) '(c b a))
    ⇒ 1

Function: -find-indices (pred list) ¶

Return the list of indices in list satisfying pred.

Each element of list in turn is passed to pred. If the result is non-nil, the index of that element in list is included in the result. The returned indices are in ascending order, i.e., in the same order as they appear in list.

This function’s anaphoric counterpart is --find-indices.

See also: -find-index (see -find-index), -elem-indices (see -elem-indices).

(-find-indices #'numberp '(a b c))
    ⇒ ()

(-find-indices #'numberp '(8 1 d 2 b c a 3))
    ⇒ (0 1 3 7)

(--find-indices (> it 5) '(2 4 1 6 3 3 5 8))
    ⇒ (3 7)

Function: -grade-up (comparator list) ¶

Grade elements of list using comparator relation. This yields a permutation vector such that applying this permutation to list sorts it in ascending order.

(-grade-up #'< '(3 1 4 2 1 3 3))
    ⇒ (1 4 3 0 5 6 2)

(let ((l '(3 1 4 2 1 3 3))) (-select-by-indices (-grade-up #'< l) l))
    ⇒ (1 1 2 3 3 3 4)

Function: -grade-down (comparator list) ¶

Grade elements of list using comparator relation. This yields a permutation vector such that applying this permutation to list sorts it in descending order.

(-grade-down #'< '(3 1 4 2 1 3 3))
    ⇒ (2 0 5 6 3 1 4)

(let ((l '(3 1 4 2 1 3 3))) (-select-by-indices (-grade-down #'< l) l))
    ⇒ (4 3 3 3 2 1 1)

2.9 Set operations

Operations pretending lists are sets.

Function: -union (list1 list2) ¶

Return a new list of distinct elements appearing in either list1 or list2.

The test for equality is done with equal, or with -compare-fn if that is non-nil.

(-union '(1 2 3) '(3 4 5))
    ⇒ (1 2 3 4 5)

(-union '(1 2 2 4) ())
    ⇒ (1 2 4)

(-union '(1 1 2 2) '(4 4 3 2 1))
    ⇒ (1 2 4 3)

Function: -difference (list1 list2) ¶

Return a new list with the distinct members of list1 that are not in list2.

The test for equality is done with equal, or with -compare-fn if that is non-nil.

(-difference () ())
    ⇒ ()

(-difference '(1 2 3) '(4 5 6))
    ⇒ (1 2 3)

(-difference '(1 2 3 4) '(3 4 5 6))
    ⇒ (1 2)

Function: -intersection (list1 list2) ¶

Return a new list of distinct elements appearing in both list1 and list2.

The test for equality is done with equal, or with -compare-fn if that is non-nil.

(-intersection () ())
    ⇒ ()

(-intersection '(1 2 3) '(4 5 6))
    ⇒ ()

(-intersection '(1 2 2 3) '(4 3 3 2))
    ⇒ (2 3)

Function: -powerset (list) ¶

Return the power set of list.

(-powerset ())
    ⇒ (nil)

(-powerset '(x y))
    ⇒ ((x y) (x) (y) nil)

(-powerset '(x y z))
    ⇒ ((x y z) (x y) (x z) (x) (y z) (y) (z) nil)

Function: -permutations (list) ¶

Return the distinct permutations of list.

Duplicate elements of list are determined by equal, or by -compare-fn if that is non-nil.

(-permutations ())
    ⇒ (nil)

(-permutations '(a a b))
    ⇒ ((a a b) (a b a) (b a a))

(-permutations '(a b c))
    ⇒ ((a b c) (a c b) (b a c) (b c a) (c a b) (c b a))

Function: -distinct (list) ¶

Return a copy of list with all duplicate elements removed.

The test for equality is done with equal, or with -compare-fn if that is non-nil.

Alias: -uniq.

(-distinct ())
    ⇒ ()

(-distinct '(1 1 2 3 3))
    ⇒ (1 2 3)

(-distinct '(t t t))
    ⇒ (t)

Function: -same-items? (list1 list2) ¶

Return non-nil if list1 and list2 have the same distinct elements.

The order of the elements in the lists does not matter. The lists may be of different lengths, i.e., contain duplicate elements. The test for equality is done with equal, or with -compare-fn if that is non-nil.

Alias: -same-items-p.

(-same-items? '(1 2 3) '(1 2 3))
    ⇒ t

(-same-items? '(1 1 2 3) '(3 3 2 1))
    ⇒ t

(-same-items? '(1 2 3) '(1 2 3 4))
    ⇒ nil

2.10 Other list operations

Other list functions not fit to be classified elsewhere.

Function: -rotate (n list) ¶

Rotate list n places to the right (left if n is negative). The time complexity is o(n).

(-rotate 3 '(1 2 3 4 5 6 7))
    ⇒ (5 6 7 1 2 3 4)

(-rotate -3 '(1 2 3 4 5 6 7))
    ⇒ (4 5 6 7 1 2 3)

(-rotate 16 '(1 2 3 4 5 6 7))
    ⇒ (6 7 1 2 3 4 5)

Function: -cons* (&rest args) ¶

Make a new list from the elements of args. The last 2 elements of args are used as the final cons of the result, so if the final element of args is not a list, the result is a dotted list. With no args, return nil.

(-cons* 1 2)
    ⇒ (1 . 2)

(-cons* 1 2 3)
    ⇒ (1 2 . 3)

(-cons* 1)
    ⇒ 1

Function: -snoc (list elem &rest elements) ¶

Append elem to the end of the list.

This is like cons, but operates on the end of list.

If any elements are given, append them to the list as well.

(-snoc '(1 2 3) 4)
    ⇒ (1 2 3 4)

(-snoc '(1 2 3) 4 5 6)
    ⇒ (1 2 3 4 5 6)

(-snoc '(1 2 3) '(4 5 6))
    ⇒ (1 2 3 (4 5 6))

Function: -interpose (sep list) ¶

Return a new list of all elements in list separated by sep.

(-interpose "-" ())
    ⇒ ()

(-interpose "-" '("a"))
    ⇒ ("a")

(-interpose "-" '("a" "b" "c"))
    ⇒ ("a" "-" "b" "-" "c")

Function: -interleave (&rest lists) ¶

Return a new list of the first item in each list, then the second etc.

(-interleave '(1 2) '("a" "b"))
    ⇒ (1 "a" 2 "b")

(-interleave '(1 2) '("a" "b") '("A" "B"))
    ⇒ (1 "a" "A" 2 "b" "B")

(-interleave '(1 2 3) '("a" "b"))
    ⇒ (1 "a" 2 "b")

Function: -iota (count &optional start step) ¶

Return a list containing count numbers. Starts from start and adds step each time. The default start is zero, the default step is 1. This function takes its name from the corresponding primitive in the apl language.

(-iota 6)
    ⇒ (0 1 2 3 4 5)

(-iota 4 2.5 -2)
    ⇒ (2.5 0.5 -1.5 -3.5)

(-iota -1)
    error→ Wrong type argument: natnump, -1

Function: -zip-with (fn list1 list2) ¶

Zip list1 and list2 into a new list using the function fn. That is, apply fn pairwise taking as first argument the next element of list1 and as second argument the next element of list2 at the corresponding position. The result is as long as the shorter list.

This function’s anaphoric counterpart is --zip-with.

For other zips, see also -zip-lists (see -zip-lists) and -zip-fill (see -zip-fill).

(-zip-with #'+ '(1 2 3 4) '(5 6 7))
    ⇒ (6 8 10)

(-zip-with #'cons '(1 2 3) '(4 5 6 7))
    ⇒ ((1 . 4) (2 . 5) (3 . 6))

(--zip-with (format "%s & %s" it other) '(Batman Jekyll) '(Robin Hyde))
    ⇒ ("Batman & Robin" "Jekyll & Hyde")

Function: -zip-pair (list1 list2) ¶

Zip list1 and list2 together.

Make a pair with the head of each list, followed by a pair with the second element of each list, and so on. The number of pairs returned is equal to the length of the shorter input list.

See also: -zip-lists (see -zip-lists).

(-zip-pair '(1 2 3 4) '(5 6 7))
    ⇒ ((1 . 5) (2 . 6) (3 . 7))

(-zip-pair '(1 2 3) '(4 5 6))
    ⇒ ((1 . 4) (2 . 5) (3 . 6))

(-zip-pair '(1 2) '(3))
    ⇒ ((1 . 3))

Function: -zip-lists (&rest lists) ¶

Zip lists together.

Group the head of each list, followed by the second element of each list, and so on. The number of returned groupings is equal to the length of the shortest input list, and the length of each grouping is equal to the number of input lists.

The return value is always a list of proper lists, in contrast to -zip (see -zip) which returns a list of dotted pairs when only two input lists are provided.

2.11 Tree operations

Functions pretending lists are trees.

Function: -tree-seq (branch children tree) ¶

Return a sequence of the nodes in tree, in depth-first search order.

branch is a predicate of one argument that returns non-nil if the passed argument is a branch, that is, a node that can have children.

children is a function of one argument that returns the children of the passed branch node.

Non-branch nodes are simply copied.

(-tree-seq 'listp 'identity '(1 (2 3) 4 (5 (6 7))))
    ⇒ ((1 (2 3) 4 (5 (6 7))) 1 (2 3) 2 3 4 (5 (6 7)) 5 (6 7) 6 7)

(-tree-seq 'listp 'reverse '(1 (2 3) 4 (5 (6 7))))
    ⇒ ((1 (2 3) 4 (5 (6 7))) (5 (6 7)) (6 7) 7 6 5 4 (2 3) 3 2 1)

(--tree-seq (vectorp it) (append it nil) [1 [2 3] 4 [5 [6 7]]])
    ⇒ ([1 [2 3] 4 [5 [6 7]]] 1 [2 3] 2 3 4 [5 [6 7]] 5 [6 7] 6 7)

Function: -tree-map (fn tree) ¶

Apply fn to each element of tree while preserving the tree structure.

(-tree-map '1+ '(1 (2 3) (4 (5 6) 7)))
    ⇒ (2 (3 4) (5 (6 7) 8))

(-tree-map '(lambda (x) (cons x (expt 2 x))) '(1 (2 3) 4))
    ⇒ ((1 . 2) ((2 . 4) (3 . 8)) (4 . 16))

(--tree-map (length it) '("<body>" ("<p>" "text" "</p>") "</body>"))
    ⇒ (6 (3 4 4) 7)

Function: -tree-map-nodes (pred fun tree) ¶

Call fun on each node of tree that satisfies pred.

If pred returns nil, continue descending down this node. If pred returns non-nil, apply fun to this node and do not descend further.

(-tree-map-nodes 'vectorp (lambda (x) (-sum (append x nil))) '(1 [2 3] 4 (5 [6 7] 8)))
    ⇒ (1 5 4 (5 13 8))

(-tree-map-nodes 'keywordp (lambda (x) (symbol-name x)) '(1 :foo 4 ((5 6 :bar) :baz 8)))
    ⇒ (1 ":foo" 4 ((5 6 ":bar") ":baz" 8))

(--tree-map-nodes (eq (car-safe it) 'add-mode) (-concat it (list :mode 'emacs-lisp-mode)) '(with-mode emacs-lisp-mode (foo bar) (add-mode a b) (baz (add-mode c d))))
    ⇒ (with-mode emacs-lisp-mode (foo bar) (add-mode a b :mode emacs-lisp-mode) (baz (add-mode c d :mode emacs-lisp-mode)))

Function: -tree-reduce (fn tree) ¶

Use fn to reduce elements of list tree. If elements of tree are lists themselves, apply the reduction recursively.

fn is first applied to first element of the list and second element, then on this result and third element from the list etc.

See -reduce-r (see -reduce-r) for how exactly are lists of zero or one element handled.

(-tree-reduce '+ '(1 (2 3) (4 5)))
    ⇒ 15

(-tree-reduce 'concat '("strings" (" on" " various") ((" levels"))))
    ⇒ "strings on various levels"

(--tree-reduce (cond ((stringp it) (concat it " " acc)) (t (let ((sn (symbol-name it))) (concat "<" sn ">" acc "</" sn ">")))) '(body (p "some words") (div "more" (b "bold") "words")))
    ⇒ "<body><p>some words</p> <div>more <b>bold</b> words</div></body>"

Function: -tree-reduce-from (fn init-value tree) ¶

Use fn to reduce elements of list tree. If elements of tree are lists themselves, apply the reduction recursively.

fn is first applied to init-value and first element of the list, then on this result and second element from the list etc.

The initial value is ignored on cons pairs as they always contain two elements.

(-tree-reduce-from '+ 1 '(1 (1 1) ((1))))
    ⇒ 8

(--tree-reduce-from (-concat acc (list it)) nil '(1 (2 3 (4 5)) (6 7)))
    ⇒ ((7 6) ((5 4) 3 2) 1)

Function: -tree-mapreduce (fn folder tree) ¶

Apply fn to each element of tree, and make a list of the results. If elements of tree are lists themselves, apply fn recursively to elements of these nested lists.

Then reduce the resulting lists using folder and initial value init-value. See -reduce-r-from (see -reduce-r-from).

This is the same as calling -tree-reduce (see -tree-reduce) after -tree-map (see -tree-map) but is twice as fast as it only traverse the structure once.

(-tree-mapreduce 'list 'append '(1 (2 (3 4) (5 6)) (7 (8 9))))
    ⇒ (1 2 3 4 5 6 7 8 9)

(--tree-mapreduce 1 (+ it acc) '(1 (2 (4 9) (2 1)) (7 (4 3))))
    ⇒ 9

(--tree-mapreduce 0 (max acc (1+ it)) '(1 (2 (4 9) (2 1)) (7 (4 3))))
    ⇒ 3

Function: -tree-mapreduce-from (fn folder init-value tree) ¶

Apply fn to each element of tree, and make a list of the results. If elements of tree are lists themselves, apply fn recursively to elements of these nested lists.

Then reduce the resulting lists using folder and initial value init-value. See -reduce-r-from (see -reduce-r-from).

This is the same as calling -tree-reduce-from (see -tree-reduce-from) after -tree-map (see -tree-map) but is twice as fast as it only traverse the structure once.

(-tree-mapreduce-from 'identity '* 1 '(1 (2 (3 4) (5 6)) (7 (8 9))))
    ⇒ 362880

(--tree-mapreduce-from (+ it it) (cons it acc) nil '(1 (2 (4 9) (2 1)) (7 (4 3))))
    ⇒ (2 (4 (8 18) (4 2)) (14 (8 6)))

(concat "{" (--tree-mapreduce-from (cond ((-cons-pair? it) (concat (symbol-name (car it)) " -> " (symbol-name (cdr it)))) (t (concat (symbol-name it) " : {"))) (concat it (unless (or (equal acc "}") (equal (substring it (1- (length it))) "{")) ", ") acc) "}" '((elisp-mode (foo (bar . booze)) (baz . qux)) (c-mode (foo . bla) (bum . bam)))))
    ⇒ "{elisp-mode : {foo : {bar -> booze}, baz -> qux}, c-mode : {foo -> bla, bum -> bam}}"

Function: -clone (list) ¶

Create a deep copy of list. The new list has the same elements and structure but all cons are replaced with new ones. This is useful when you need to clone a structure such as plist or alist.

(let* ((a (list (list 1))) (b (-clone a))) (setcar (car a) 2) b)
    ⇒ ((1))

2.12 Threading macros

Macros that conditionally combine sequential forms for brevity or readability.

Macro: -> (x &optional form &rest more) ¶

Thread the expr through the forms. Insert x as the second item in the first form, making a list of it if it is not a list already. If there are more forms, insert the first form as the second item in second form, etc.

(-> '(2 3 5))
    ⇒ (2 3 5)

(-> '(2 3 5) (append '(8 13)))
    ⇒ (2 3 5 8 13)

(-> '(2 3 5) (append '(8 13)) (-slice 1 -1))
    ⇒ (3 5 8)

Macro: ->> (x &optional form &rest more) ¶

Thread the expr through the forms. Insert x as the last item in the first form, making a list of it if it is not a list already. If there are more forms, insert the first form as the last item in second form, etc.

(->> '(1 2 3) (-map 'square))
    ⇒ (1 4 9)

(->> '(1 2 3) (-map 'square) (-remove 'even?))
    ⇒ (1 9)

(->> '(1 2 3) (-map 'square) (-reduce '+))
    ⇒ 14

Macro: --> (x &rest forms) ¶

Starting with the value of x, thread each expression through forms.

Insert x at the position signified by the symbol it in the first form. If there are more forms, insert the first form at the position signified by it in the second form, etc.

(--> "def" (concat "abc" it "ghi"))
    ⇒ "abcdefghi"

(--> "def" (concat "abc" it "ghi") (upcase it))
    ⇒ "ABCDEFGHI"

(--> "def" (concat "abc" it "ghi") upcase)
    ⇒ "ABCDEFGHI"

Macro: -as-> (value variable &rest forms) ¶

Starting with value, thread variable through forms.

In the first form, bind variable to value. In the second form, bind variable to the result of the first form, and so forth.

(-as-> 3 my-var (1+ my-var) (list my-var) (mapcar (lambda (ele) (* 2 ele)) my-var))
    ⇒ (8)

(-as-> 3 my-var 1+)
    ⇒ 4

(-as-> 3 my-var)
    ⇒ 3

Macro: -some-> (x &optional form &rest more) ¶

When expr is non-nil, thread it through the first form (via -> (see ->)), and when that result is non-nil, through the next form, etc.

(-some-> '(2 3 5))
    ⇒ (2 3 5)

(-some-> 5 square)
    ⇒ 25

(-some-> 5 even? square)
    ⇒ nil

Macro: -some->> (x &optional form &rest more) ¶

When expr is non-nil, thread it through the first form (via ->> (see ->>)), and when that result is non-nil, through the next form, etc.

(-some->> '(1 2 3) (-map 'square))
    ⇒ (1 4 9)

(-some->> '(1 3 5) (-last 'even?) (+ 100))
    ⇒ nil

(-some->> '(2 4 6) (-last 'even?) (+ 100))
    ⇒ 106

Macro: -some--> (expr &rest forms) ¶

Thread expr through forms via --> (see -->), while the result is non-nil. When expr evaluates to non-nil, thread the result through the first of forms, and when that result is non-nil, thread it through the next form, etc.

(-some--> "def" (concat "abc" it "ghi"))
    ⇒ "abcdefghi"

(-some--> nil (concat "abc" it "ghi"))
    ⇒ nil

(-some--> '(0 1) (-remove #'natnump it) (append it it) (-map #'1+ it))
    ⇒ ()

Macro: -doto (init &rest forms) ¶

Evaluate init and pass it as argument to forms with -> (see ->). The result of evaluating init is threaded through each of forms individually using -> (see ->), which see. The return value is result, which forms may have modified by side effect.

(-doto (list 1 2 3) pop pop)
    ⇒ (3)

(-doto (cons 1 2) (setcar 3) (setcdr 4))
    ⇒ (3 . 4)

(gethash 'k (--doto (make-hash-table) (puthash 'k 'v it)))
    ⇒ v

2.13 Binding

Macros that combine let and let* with destructuring and flow control.

Macro: -when-let ((var val) &rest body) ¶

If val evaluates to non-nil, bind it to var and execute body.

Note: binding is done according to -let (see -let).

(-when-let (match-index (string-match "d" "abcd")) (+ match-index 2))
    ⇒ 5

(-when-let ((&plist :foo foo) (list :foo "foo")) foo)
    ⇒ "foo"

(-when-let ((&plist :foo foo) (list :bar "bar")) foo)
    ⇒ nil

Macro: -when-let* (vars-vals &rest body) ¶

If all vals evaluate to true, bind them to their corresponding vars and execute body. vars-vals should be a list of (var val) pairs.

Note: binding is done according to -let* (see -let*). vals are evaluated sequentially, and evaluation stops after the first nil val is encountered.

(-when-let* ((x 5) (y 3) (z (+ y 4))) (+ x y z))
    ⇒ 15

(-when-let* ((x 5) (y nil) (z 7)) (+ x y z))
    ⇒ nil

Macro: -if-let ((var val) then &rest else) ¶

If val evaluates to non-nil, bind it to var and do then, otherwise do else.

Note: binding is done according to -let (see -let).

(-if-let (match-index (string-match "d" "abc")) (+ match-index 3) 7)
    ⇒ 7

(--if-let (even? 4) it nil)
    ⇒ t

Macro: -if-let* (vars-vals then &rest else) ¶

If all vals evaluate to true, bind them to their corresponding vars and do then, otherwise do else. vars-vals should be a list of (var val) pairs.

Note: binding is done according to -let* (see -let*). vals are evaluated sequentially, and evaluation stops after the first nil val is encountered.

(-if-let* ((x 5) (y 3) (z 7)) (+ x y z) "foo")
    ⇒ 15

(-if-let* ((x 5) (y nil) (z 7)) (+ x y z) "foo")
    ⇒ "foo"

(-if-let* (((_ _ x) '(nil nil 7))) x)
    ⇒ 7

Macro: -let (varlist &rest body) ¶

Bind variables according to varlist then eval body.

varlist is a list of lists of the form (pattern source). Each pattern is matched against the source "structurally". source is only evaluated once for each pattern. Each pattern is matched recursively, and can therefore contain sub-patterns which are matched against corresponding sub-expressions of source.

All the SOURCEs are evalled before any symbols are bound (i.e. "in parallel").

If varlist only contains one (pattern source) element, you can optionally specify it using a vector and discarding the outer-most parens. Thus

(-let ((pattern source)) …)

becomes

(-let [pattern source] …).

-let (see -let) uses a convention of not binding places (symbols) starting with _ whenever it’s possible. You can use this to skip over entries you don’t care about. However, this is not *always* possible (as a result of implementation) and these symbols might get bound to undefined values.

Following is the overview of supported patterns. Remember that patterns can be matched recursively, so every a, b, aK in the following can be a matching construct and not necessarily a symbol/variable.

Symbol:

a - bind the source to a. This is just like regular let.

Conses and lists:

(a) - bind car of cons/list to a

(a . b) - bind car of cons to a and cdr to b

(a b) - bind car of list to a and cadr to b

(a1 a2 a3 …) - bind 0th car of list to a1, 1st to a2, 2nd to a3...

(a1 a2 a3 … aN . rest) - as above, but bind the Nth cdr to rest.

Vectors:

[a] - bind 0th element of a non-list sequence to a (works with vectors, strings, bit arrays…)

[a1 a2 a3 …] - bind 0th element of non-list sequence to a0, 1st to a1, 2nd to a2, ... If the pattern is shorter than source, the values at places not in pattern are ignored. If the pattern is longer than source, an error is thrown.

[a1 a2 a3 … &rest rest] - as above, but bind the rest of the sequence to rest. This is conceptually the same as improper list matching (a1 a2 … aN . rest)

Key/value stores:

(&plist key0 a0 … keyN aN) - bind value mapped by keyK in the source plist to aK. If the value is not found, aK is nil. Uses plist-get to fetch values.

(&alist key0 a0 … keyN aN) - bind value mapped by keyK in the source alist to aK. If the value is not found, aK is nil. Uses assoc to fetch values.

(&hash key0 a0 … keyN aN) - bind value mapped by keyK in the source hash table to aK. If the value is not found, aK is nil. Uses gethash to fetch values.

Further, special keyword &keys supports "inline" matching of plist-like key-value pairs, similarly to &keys keyword of cl-defun.

(a1 a2 … aN &keys key1 b1 … keyN bK)

This binds n values from the list to a1 … aN, then interprets the cdr as a plist (see key/value matching above).

a shorthand notation for kv-destructuring exists which allows the patterns be optionally left out and derived from the key name in the following fashion:

- a key :foo is converted into foo pattern, - a key ’bar is converted into bar pattern, - a key "baz" is converted into baz pattern.

That is, the entire value under the key is bound to the derived variable without any further destructuring.

This is possible only when the form following the key is not a valid pattern (i.e. not a symbol, a cons cell or a vector). Otherwise the matching proceeds as usual and in case of an invalid spec fails with an error.

Thus the patterns are normalized as follows:

;; derive all the missing patterns (&plist :foo ’bar "baz") => (&plist :foo foo ’bar bar "baz" baz)

;; we can specify some but not others (&plist :foo ’bar explicit-bar) => (&plist :foo foo ’bar explicit-bar)

;; nothing happens, we store :foo in x (&plist :foo x) => (&plist :foo x)

;; nothing happens, we match recursively (&plist :foo (a b c)) => (&plist :foo (a b c))

You can name the source using the syntax symbol &as pattern. This syntax works with lists (proper or improper), vectors and all types of maps.

(list &as a b c) (list 1 2 3)

binds a to 1, b to 2, c to 3 and list to (1 2 3).

Similarly:

(bounds &as beg . end) (cons 1 2)

binds beg to 1, end to 2 and bounds to (1 . 2).

(items &as first . rest) (list 1 2 3)

binds first to 1, rest to (2 3) and items to (1 2 3)

[vect &as _ b c] [1 2 3]

binds b to 2, c to 3 and vect to [1 2 3] (_ avoids binding as usual).

(plist &as &plist :b b) (list :a 1 :b 2 :c 3)

binds b to 2 and plist to (:a 1 :b 2 :c 3). Same for &alist and &hash.

This is especially useful when we want to capture the result of a computation and destructure at the same time. Consider the form (function-returning-complex-structure) returning a list of two vectors with two items each. We want to capture this entire result and pass it to another computation, but at the same time we want to get the second item from each vector. We can achieve it with pattern

(result &as [_ a] [_ b]) (function-returning-complex-structure)

Note: Clojure programmers may know this feature as the ":as binding". The difference is that we put the &as at the front because we need to support improper list binding.

(-let (([a (b c) d] [1 (2 3) 4])) (list a b c d))
    ⇒ (1 2 3 4)

(-let [(a b c . d) (list 1 2 3 4 5 6)] (list a b c d))
    ⇒ (1 2 3 (4 5 6))

(-let [(&plist :foo foo :bar bar) (list :baz 3 :foo 1 :qux 4 :bar 2)] (list foo bar))
    ⇒ (1 2)

Macro: -let* (varlist &rest body) ¶

Bind variables according to varlist then eval body.

varlist is a list of lists of the form (pattern source). Each pattern is matched against the source structurally. source is only evaluated once for each pattern.

Each source can refer to the symbols already bound by this varlist. This is useful if you want to destructure source recursively but also want to name the intermediate structures.

See -let (see -let) for the list of all possible patterns.

(-let* (((a . b) (cons 1 2)) ((c . d) (cons 3 4))) (list a b c d))
    ⇒ (1 2 3 4)

(-let* (((a . b) (cons 1 (cons 2 3))) ((c . d) b)) (list a b c d))
    ⇒ (1 (2 . 3) 2 3)

(-let* (((&alist "foo" foo "bar" bar) (list (cons "foo" 1) (cons "bar" (list 'a 'b 'c)))) ((a b c) bar)) (list foo a b c bar))
    ⇒ (1 a b c (a b c))

Macro: -lambda (match-form &rest body) ¶

Return a lambda which destructures its input as match-form and executes body.

Note that you have to enclose the match-form in a pair of parens, such that:

(-lambda (x) body) (-lambda (x y …) body)

has the usual semantics of lambda. Furthermore, these get translated into normal lambda, so there is no performance penalty.

See -let (see -let) for a description of the destructuring mechanism.

(-map (-lambda ((x y)) (+ x y)) '((1 2) (3 4) (5 6)))
    ⇒ (3 7 11)

(-map (-lambda ([x y]) (+ x y)) '([1 2] [3 4] [5 6]))
    ⇒ (3 7 11)

(funcall (-lambda ((_ . a) (_ . b)) (-concat a b)) '(1 2 3) '(4 5 6))
    ⇒ (2 3 5 6)

Macro: -setq ([match-form val] ...) ¶

Bind each match-form to the value of its val.

match-form destructuring is done according to the rules of -let (see -let).

This macro allows you to bind multiple variables by destructuring the value, so for example:

(-setq (a b) x (&plist :c c) plist)

expands roughly speaking to the following code

(setq a (car x) b (cadr x) c (plist-get plist :c))

Care is taken to only evaluate each val once so that in case of multiple assignments it does not cause unexpected side effects.

(let (a) (-setq a 1) a)
    ⇒ 1

(let (a b) (-setq (a b) (list 1 2)) (list a b))
    ⇒ (1 2)

(let (c) (-setq (&plist :c c) (list :c "c")) c)
    ⇒ "c"

2.14 Side effects

Functions iterating over lists for side effect only.

Function: -each (list fn) ¶

Call fn on each element of list. Return nil; this function is intended for side effects.

Its anaphoric counterpart is --each.

For access to the current element’s index in list, see -each-indexed (see -each-indexed).

(let (l) (-each '(1 2 3) (lambda (x) (push x l))) l)
    ⇒ (3 2 1)

(let (l) (--each '(1 2 3) (push it l)) l)
    ⇒ (3 2 1)

(-each '(1 2 3) #'identity)
    ⇒ nil

Function: -each-while (list pred fn) ¶

Call fn on each item in list, while (pred item) is non-nil. Once an item is reached for which pred returns nil, fn is no longer called. Return nil; this function is intended for side effects.

Its anaphoric counterpart is --each-while.

(let (l) (-each-while '(2 4 5 6) #'even? (lambda (x) (push x l))) l)
    ⇒ (4 2)

(let (l) (--each-while '(1 2 3 4) (< it 3) (push it l)) l)
    ⇒ (2 1)

(let ((s 0)) (--each-while '(1 3 4 5) (< it 5) (setq s (+ s it))) s)
    ⇒ 8

Function: -each-indexed (list fn) ¶

Call fn on each index and element of list. For each item at index in list, call (funcall fn index item). Return nil; this function is intended for side effects.

See also: -map-indexed (see -map-indexed).

(let (l) (-each-indexed '(a b c) (lambda (i x) (push (list x i) l))) l)
    ⇒ ((c 2) (b 1) (a 0))

(let (l) (--each-indexed '(a b c) (push (list it it-index) l)) l)
    ⇒ ((c 2) (b 1) (a 0))

(let (l) (--each-indexed () (push it l)) l)
    ⇒ ()

Function: -each-r (list fn) ¶

Call fn on each element of list in reversed order. Return nil; this function is intended for side effects.

Its anaphoric counterpart is --each-r.

(let (l) (-each-r '(1 2 3) (lambda (x) (push x l))) l)
    ⇒ (1 2 3)

(let (l) (--each-r '(1 2 3) (push it l)) l)
    ⇒ (1 2 3)

(-each-r '(1 2 3) #'identity)
    ⇒ nil

Function: -each-r-while (list pred fn) ¶

Call fn on each item in reversed list, while (pred item) is non-nil. Once an item is reached for which pred returns nil, fn is no longer called. Return nil; this function is intended for side effects.

Its anaphoric counterpart is --each-r-while.

(let (l) (-each-r-while '(2 4 5 6) #'even? (lambda (x) (push x l))) l)
    ⇒ (6)

(let (l) (--each-r-while '(1 2 3 4) (>= it 3) (push it l)) l)
    ⇒ (3 4)

(let ((s 0)) (--each-r-while '(1 2 3 5) (> it 1) (setq s (+ s it))) s)
    ⇒ 10

Function: -dotimes (num fn) ¶

Call fn num times, presumably for side effects. fn is called with a single argument on successive integers running from 0, inclusive, to num, exclusive. fn is not called if num is less than 1.

This function’s anaphoric counterpart is --dotimes.

(let (s) (-dotimes 3 (lambda (n) (push n s))) s)
    ⇒ (2 1 0)

(let (s) (-dotimes 0 (lambda (n) (push n s))) s)
    ⇒ ()

(let (s) (--dotimes 5 (push it s)) s)
    ⇒ (4 3 2 1 0)

2.15 Destructive operations

Macros that modify variables holding lists.

Macro: !cons (car cdr) ¶

Destructive: Set cdr to the cons of car and cdr.

(let (l) (!cons 5 l) l)
    ⇒ (5)

(let ((l '(3))) (!cons 5 l) l)
    ⇒ (5 3)

Macro: !cdr (list) ¶

Destructive: Set list to the cdr of list.

(let ((l '(3))) (!cdr l) l)
    ⇒ ()

(let ((l '(3 5))) (!cdr l) l)
    ⇒ (5)

2.16 Function combinators

Functions that manipulate and compose other functions.

Function: -partial (fun &rest args) ¶

Return a function that is a partial application of fun to args. args is a list of the first n arguments to pass to fun. The result is a new function which does the same as fun, except that the first n arguments are fixed at the values with which this function was called.

(funcall (-partial #'+ 5))
    ⇒ 5

(funcall (-partial #'- 5) 3)
    ⇒ 2

(funcall (-partial #'+ 5 2) 3)
    ⇒ 10

Function: -rpartial (fn &rest args) ¶

Return a function that is a partial application of fn to args. args is a list of the last n arguments to pass to fn. The result is a new function which does the same as fn, except that the last n arguments are fixed at the values with which this function was called. This is like -partial (see -partial), except the arguments are fixed starting from the right rather than the left.

(funcall (-rpartial #'- 5))
    ⇒ -5

(funcall (-rpartial #'- 5) 8)
    ⇒ 3

(funcall (-rpartial #'- 5 2) 10)
    ⇒ 3

Function: -juxt (&rest fns) ¶

Return a function that is the juxtaposition of fns. The returned function takes a variable number of args, applies each of fns in turn to args, and returns the list of results.

(funcall (-juxt) 1 2)
    ⇒ ()

(funcall (-juxt #'+ #'- #'* #'/) 7 5)
    ⇒ (12 2 35 1)

(mapcar (-juxt #'number-to-string #'1+) '(1 2))
    ⇒ (("1" 2) ("2" 3))

Function: -compose (&rest fns) ¶

Compose fns into a single composite function. Return a function that takes a variable number of args, applies the last function in fns to args, and returns the result of calling each remaining function on the result of the previous function, right-to-left. If no fns are given, return a variadic identity function.

(funcall (-compose #'- #'1+ #'+) 1 2 3)
    ⇒ -7

(funcall (-compose #'identity #'1+) 3)
    ⇒ 4

(mapcar (-compose #'not #'stringp) '(nil ""))
    ⇒ (t nil)

Function: -applify (fn) ¶

Return a function that applies fn to a single list of args. This changes the arity of fn from taking n distinct arguments to taking 1 argument which is a list of n arguments.

(funcall (-applify #'+) nil)
    ⇒ 0

(mapcar (-applify #'+) '((1 1 1) (1 2 3) (5 5 5)))
    ⇒ (3 6 15)

(funcall (-applify #'<) '(3 6))
    ⇒ t

Function: -on (op trans) ¶

Return a function that calls trans on each arg and op on the results. The returned function takes a variable number of arguments, calls the function trans on each one in turn, and then passes those results as the list of arguments to op, in the same order.

For example, the following pairs of expressions are morally equivalent:

(funcall (-on #’+ #’1+) 1 2 3) = (+ (1+ 1) (1+ 2) (1+ 3)) (funcall (-on #’+ #’1+)) = (+)

(-sort (-on #'< #'length) '((1 2 3) (1) (1 2)))
    ⇒ ((1) (1 2) (1 2 3))

(funcall (-on #'min #'string-to-number) "22" "2" "1" "12")
    ⇒ 1

(-min-by (-on #'> #'length) '((1 2 3) (4) (1 2)))
    ⇒ (4)

Function: -flip (fn) ¶

Return a function that calls fn with its arguments reversed. The returned function takes the same number of arguments as fn.

For example, the following two expressions are morally equivalent:

(funcall (-flip #’-) 1 2) = (- 2 1)

See also: -rotate-args (see -rotate-args).

(-sort (-flip #'<) '(4 3 6 1))
    ⇒ (6 4 3 1)

(funcall (-flip #'-) 3 2 1 10)
    ⇒ 4

(funcall (-flip #'1+) 1)
    ⇒ 2

Function: -rotate-args (n fn) ¶

Return a function that calls fn with args rotated n places to the right. The returned function takes the same number of arguments as fn, rotates the list of arguments n places to the right (left if n is negative) just like -rotate (see -rotate), and applies fn to the result.

3 Development

The Dash repository is hosted on GitHub at https://github.com/magnars/dash.el.

Contribute
Contributors

3.1 Contribute

Yes, please do. Pure functions in the list manipulation realm only, please. There’s a suite of examples/tests in dev/examples.el, so remember to add tests for your additions, or they may get broken later.

Run the tests with ‘make check’. Regenerate the docs with ‘make docs’. Contributors are encouraged to install these commands as a Git pre-commit hook, so that the tests are always running and the docs are always in sync:

$ cp dev/pre-commit.sh .git/hooks/pre-commit

Oh, and don’t edit README.md or dash.texi directly, as they are auto-generated. Instead, change their respective templates readme-template.md or dash-template.texi.

To ensure that Dash can be distributed with GNU ELPA or Emacs, we require that all contributors assign copyright to the Free Software Foundation. For more on this, see Copyright Assignment in The GNU Emacs Manual.

3.2 Contributors

Matus Goljer contributed lots of features and functions.
Takafumi Arakaki contributed -group-by.
tali713 is the author of -applify.
Víctor M. Valenzuela contributed -repeat.
Nic Ferrier contributed -cons*.
Wilfred Hughes contributed -slice, -first-item, and -last-item.
Emanuel Evans contributed -if-let, -when-let, and -insert-at.
Johan Andersson contributed -sum, -product, and -same-items?.
Christina Whyte contributed -compose.
Steve Lamb contributed -cycle, -pad, -annotate, -zip-fill, and a variadic version of -zip.
Fredrik Bergroth made the -if-let family use -let destructuring and improved the script for generating documentation.
Mark Oteiza contributed -iota and the script to create an Info manual.
Vasilij Schneidermann contributed -some.
William West made -fixfn more robust at handling floats.
Cam Saul contributed -some->, -some->>, and -some-->.
Basil L. Contovounesios contributed -common-prefix, -common-suffix, and various other improvements.
Paul Pogonyshev contributed -each-r and -each-r-while.

Thanks!

New contributors are very welcome. See Contribute.

Appendix A GNU Free Documentation License

Version 1.3, 3 November 2008

Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
https://fsf.org/

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

The “publisher” means any person or entity that distributes copies of the Document to the public.

A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.
COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
4. Preserve all the copyright notices of the Document.
5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
8. Include an unaltered copy of this License.
9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
15. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
TRANSLATION
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
RELICENSING
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.

“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.

An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

  Copyright (C)  year  your name.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.3
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  Texts.  A copy of the license is included in the section entitled ``GNU
  Free Documentation License''.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:

    with the Invariant Sections being list their titles, with
    the Front-Cover Texts being list, and with the Back-Cover Texts
    being list.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.

Appendix B GNU General Public License

Version 3, 29 June 2007

Copyright © 2007 Free Software Foundation, Inc. https://fsf.org/

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Preamble

The GNU General Public License is a free, copyleft license for software and other kinds of works.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program—to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.

For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.

Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.

Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.

The precise terms and conditions for copying, distribution and modification follow.

TERMS AND CONDITIONS

Definitions.
“This License” refers to version 3 of the GNU General Public License.

“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.

A “covered work” means either the unmodified Program or a work based on the Program.

To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
Source Code.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.

A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same work.
Basic Permissions.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
Protecting Users’ Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.
Conveying Verbatim Copies.
You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
1. The work must carry prominent notices stating that you modified it, and giving a relevant date.
2. The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
3. You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
4. If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
1. Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
2. Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
3. Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
4. Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
5. Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.

A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.

“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
Additional Terms.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
1. Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
2. Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
3. Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
4. Limiting the use for publicity purposes of names of licensors or authors of the material; or
5. Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
6. Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
Termination.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
Patents.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.

A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
No Surrender of Others’ Freedom.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

one line to give the program's name and a brief idea of what it does.
Copyright (C) year name of author

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see https://www.gnu.org/licenses/.

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:

program Copyright (C) year name of author
This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’.
This is free software, and you are welcome to redistribute it
under certain conditions; type ‘show c’ for details.

The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.

You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see https://www.gnu.org/licenses/.

The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read https://www.gnu.org/licenses/why-not-lgpl.html.

Index

Jump to:	! - D G

	Index Entry	Section

!
	`!cdr`:	Destructive operations
	`!cons`:	Destructive operations

-
	`-->`:	Threading macros
	`->`:	Threading macros
	`->>`:	Threading macros
	`-all?`:	Predicates
	`-andfn`:	Function combinators
	`-annotate`:	Maps
	`-any?`:	Predicates
	`-applify`:	Function combinators
	`-as->`:	Threading macros
	`-butlast`:	Other list operations
	`-clone`:	Tree operations
	`-common-prefix`:	Reductions
	`-common-suffix`:	Reductions
	`-compose`:	Function combinators
	`-concat`:	List to list
	`-cons*`:	Other list operations
	`-cons-pair?`:	Predicates
	`-const`:	Function combinators
	`-contains?`:	Predicates
	`-copy`:	Maps
	`-count`:	Reductions
	`-cut`:	Function combinators
	`-cycle`:	Unfolding
	`-difference`:	Set operations
	`-distinct`:	Set operations
	`-dotimes`:	Side effects
	`-doto`:	Threading macros
	`-drop`:	Sublist selection
	`-drop-last`:	Sublist selection
	`-drop-while`:	Sublist selection
	`-each`:	Side effects
	`-each-indexed`:	Side effects
	`-each-r`:	Side effects
	`-each-r-while`:	Side effects
	`-each-while`:	Side effects
	`-elem-index`:	Indexing
	`-elem-indices`:	Indexing
	`-every`:	Predicates
	`-fifth-item`:	Other list operations
	`-filter`:	Sublist selection
	`-find-index`:	Indexing
	`-find-indices`:	Indexing
	`-find-last-index`:	Indexing
	`-first`:	Other list operations
	`-first-item`:	Other list operations
	`-fix`:	Other list operations
	`-fixfn`:	Function combinators
	`-flatten`:	List to list
	`-flatten-n`:	List to list
	`-flip`:	Function combinators
	`-fourth-item`:	Other list operations
	`-frequencies`:	Reductions
	`-grade-down`:	Indexing
	`-grade-up`:	Indexing
	`-group-by`:	Partitioning
	`-if-let`:	Binding
	`-if-let*`:	Binding
	`-inits`:	Reductions
	`-insert-at`:	List to list
	`-interleave`:	Other list operations
	`-interpose`:	Other list operations
	`-intersection`:	Set operations
	`-iota`:	Other list operations
	`-is-infix?`:	Predicates
	`-is-prefix?`:	Predicates
	`-is-suffix?`:	Predicates
	`-iterate`:	Unfolding
	`-iteratefn`:	Function combinators
	`-juxt`:	Function combinators
	`-keep`:	List to list
	`-lambda`:	Binding
	`-last`:	Other list operations
	`-last-item`:	Other list operations
	`-let`:	Binding
	`-let*`:	Binding
	`-list`:	Other list operations
	`-map`:	Maps
	`-map-first`:	Maps
	`-map-indexed`:	Maps
	`-map-last`:	Maps
	`-map-when`:	Maps
	`-mapcat`:	Maps
	`-max`:	Reductions
	`-max-by`:	Reductions
	`-min`:	Reductions
	`-min-by`:	Reductions
	`-non-nil`:	Sublist selection
	`-none?`:	Predicates
	`-not`:	Function combinators
	`-on`:	Function combinators
	`-only-some?`:	Predicates
	`-orfn`:	Function combinators
	`-pad`:	Other list operations
	`-partial`:	Function combinators
	`-partition`:	Partitioning
	`-partition-after-item`:	Partitioning
	`-partition-after-pred`:	Partitioning
	`-partition-all`:	Partitioning
	`-partition-all-in-steps`:	Partitioning
	`-partition-before-item`:	Partitioning
	`-partition-before-pred`:	Partitioning
	`-partition-by`:	Partitioning
	`-partition-by-header`:	Partitioning
	`-partition-in-steps`:	Partitioning
	`-permutations`:	Set operations
	`-powerset`:	Set operations
	`-prodfn`:	Function combinators
	`-product`:	Reductions
	`-reduce`:	Reductions
	`-reduce-from`:	Reductions
	`-reduce-r`:	Reductions
	`-reduce-r-from`:	Reductions
	`-reductions`:	Reductions
	`-reductions-from`:	Reductions
	`-reductions-r`:	Reductions
	`-reductions-r-from`:	Reductions
	`-remove`:	Sublist selection
	`-remove-at`:	List to list
	`-remove-at-indices`:	List to list
	`-remove-first`:	Sublist selection
	`-remove-item`:	Sublist selection
	`-remove-last`:	Sublist selection
	`-repeat`:	Unfolding
	`-replace`:	List to list
	`-replace-at`:	List to list
	`-replace-first`:	List to list
	`-replace-last`:	List to list
	`-rotate`:	Other list operations
	`-rotate-args`:	Function combinators
	`-rpartial`:	Function combinators
	`-running-product`:	Reductions
	`-running-sum`:	Reductions
	`-same-items?`:	Set operations
	`-second-item`:	Other list operations
	`-select-by-indices`:	Sublist selection
	`-select-column`:	Sublist selection
	`-select-columns`:	Sublist selection
	`-separate`:	Partitioning
	`-setq`:	Binding
	`-slice`:	Sublist selection
	`-snoc`:	Other list operations
	`-some`:	Predicates
	`-some-->`:	Threading macros
	`-some->`:	Threading macros
	`-some->>`:	Threading macros
	`-sort`:	Other list operations
	`-splice`:	Maps
	`-splice-list`:	Maps
	`-split-at`:	Partitioning
	`-split-on`:	Partitioning
	`-split-when`:	Partitioning
	`-split-with`:	Partitioning
	`-sum`:	Reductions
	`-table`:	Other list operations
	`-table-flat`:	Other list operations
	`-tails`:	Reductions
	`-take`:	Sublist selection
	`-take-last`:	Sublist selection
	`-take-while`:	Sublist selection
	`-third-item`:	Other list operations
	`-tree-map`:	Tree operations
	`-tree-map-nodes`:	Tree operations
	`-tree-mapreduce`:	Tree operations
	`-tree-mapreduce-from`:	Tree operations
	`-tree-reduce`:	Tree operations
	`-tree-reduce-from`:	Tree operations
	`-tree-seq`:	Tree operations
	`-unfold`:	Unfolding
	`-union`:	Set operations
	`-unzip`:	Other list operations
	`-unzip-lists`:	Other list operations
	`-update-at`:	List to list
	`-when-let`:	Binding
	`-when-let*`:	Binding
	`-zip`:	Other list operations
	`-zip-fill`:	Other list operations
	`-zip-lists`:	Other list operations
	`-zip-lists-fill`:	Other list operations
	`-zip-pair`:	Other list operations
	`-zip-with`:	Other list operations

D
	`dash-fontify-mode`:	Fontification of special variables
	`dash-register-info-lookup`:	Info symbol lookup

G
	`global-dash-fontify-mode`:	Fontification of special variables

Jump to:	! - D G

Dash: A modern list library for GNU Emacs.

Dash

Table of Contents

1 Installation

1.1 Using in a package

1.2 Fontification of special variables

1.3 Info symbol lookup

2 Functions

2.1 Maps

2.2 Sublist selection

2.3 List to list

2.4 Reductions

2.5 Unfolding

2.6 Predicates

2.7 Partitioning

2.8 Indexing

2.9 Set operations

2.10 Other list operations

2.11 Tree operations

2.12 Threading macros

2.13 Binding

2.14 Side effects

2.15 Destructive operations

2.16 Function combinators

3 Development

3.1 Contribute

3.2 Contributors

Appendix A GNU Free Documentation License

ADDENDUM: How to use this License for your documents

Appendix B GNU General Public License

Preamble

TERMS AND CONDITIONS

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

Index