abarbu / traversal

Chicken egg that implements various functions for traversing data structures

Traversal

This is a Chicken Scheme egg which contains various list and vector traversal functions. Many of the functions provided by this egg originate from Jeff Siskind's QobiScheme.

overall

The final character of many of these functions denotes the compairson function being used. 'q' compares with 'eq?', 'v' compares with 'eqv?', 'e' with 'equal?', 'p' and the lack of a final character denotes that the function takes a user-provided predicate.

The following documentation uses the following notation: 'l' list, 'n' number, 'v' vector, 'p' procedure (usually a predicate).

Some of the functionality of this egg is provided by other eggs, like srfi-1, with different naming conventions.

lists

(countq x l)

(countv x l)

(counte x l)

(countp p x l)

(count-if p l)

(count-if-not p l)

(findq x l)

(findv x l)

(finde x l)

(findp p x l)

(find-if p l)

(find-if-not p l)

(positionq x l)

(positionv x l)

(positione x l)

(position p l)

(positionp p x l)

(position-if p l)

(position-if-not p l)

(vector-positione val vector)

(remove-if p l)

(remove-if-not p l)

(removee x l)

(removep p x l)

(removeq x l)

(removev x l)

(remove-duplicatesq l)

(remove-duplicatesv l)

(remove-duplicates p l)

(remove-duplicatese x l)

(list-set! l i x)

(list-insert l i x)

(list-remove l i)

(list-replace l i x)

(equivalence-classesq x)

(equivalence-classesv x)

(equivalence-classes p x)

(equivalence-classese x)

(transitive-equivalence-classes p x)

(adjoinq x l)

(adjoinv x l)

(adjoin x l)

(adjoinp p x l)

(rest l)

(but-last l)

(sublist list start end)

(every-other list)

(take-until p l)

(drop-until p l)

Misc list manipulation stuff.

(group-by key l)

Find equivalence classes of the elements of l that are equal? given output of key.

(sort list predicate key)

Merge sort.

(lexicographically

(minimal-membersp

(unzip l)

Transposes lists.

creation

(enumerate n)

(enumerate-vector n)

Produce a list or a vector containing 0 through n-1.

assertions

(some p l)

(some-n p n)

(some-vector p v)

(every-n p n)

(every-vector p v)

(one p l . &rest)

(one-n p n)

(one-vector p v . &rest)

(pairwise? p l)

Does p hold on each adjacent pair of elements in l.

traversal

(for-each-n f n)

(for-each-n-decreasing f n)

(map-n f n)

(map-n-vector f n)

(for-each-from-a-up-to-b f a b)

(for-each-m-n f m n)

(for-each-m-n-indexed f m n)

(for-each-m-n-dec f m n)

(map-m-n f m n)

(map-m-n-indexed f m n)

(for-each-vector f v . &rest)

(map-vector f v . &rest)

Like 'vector-map' but take an arbitrary number of vectors.

(map-linear f start end n)

Map linearly between 'start' and 'end' in 'n' steps.

(reduce-n f i n)

(reduce-vector f i v)

(map-reduce g i f l . ls)

(map-reduce-n g i f n)

(map-reduce-vector g i f v . vs)

(map-reduce2 g i f l)

(map-reduce3 g i f l1 l2)

Reduces are left folds.

(for-each-indexed f l)

(map-indexed f l)

(for-each-indexed-vector f v)

(map-indexed-vector f v . &rest)

Passes 'f' both the element and an offset into the list/vector.

(map-medial f l key)

'f' is passed each adjacent pair of elements in l after being sorted by the key. Key must return a number given each element of l.

(all-pairs l)

(map-all-pairs f l)

'f' is passed each adjacent pair of elements in l.

(memp p x l)

(assp p x alist)

Like memq and assq but take a predicate for comparison.

(map-accum f i l)

f will be passed the accumulator and each element of the list.

sets

(set-unionq x y)

(set-unionv x y)

(set-union p x y)

(set-unione x y)

(set-unionvt x y)

(set-differenceq x y)

(set-differencev x y)

(set-difference p x y)

(set-differencee x y)

(set-differencevt x y)

(set-intersectionq x y)

(set-intersectionv x y)

(set-intersection p x y)

(set-intersectione x y)

(set-intersectionvt x y)

(set-equalq? x y)

(set-equalv? x y)

(set-equale? x y)

(set-equal? p x y)

(subsetq? x y)

(subsetv? x y)

(subsete? x y)

(subset? p x y)

(subsetvt? x y)

rings

(ring-backward l)

(ring-forward l)

(ring-forward-between r a b)

(ring-forward-to l o)

These manipulate a list while treating it as a ring.

minimizing and maximizing

(maximump l)

(minimump l)

(maximum p l)

(minimum p l)

(maximum-with-position l)

(minimum-with-position l)

p is a function that returns a number.

math

(sum l)

(sum p n)

(sum p l)

(product l)

(product p n)

(product p l)

(factorial n)

(choose n m)

QobiScheme compatibility

(qfind x l)

(qcount x l)

(qposition x l)

(qremove x l)

(qremove-duplicates l)

(qtopological-sort p l)

(qset-difference x y)

(qset-intersection x y)

(qset-union x y)

(qset-equal? x y)

(qreduce f l i)

(qreduce-vector f v i)

(qreduce-n f n i)

(qmap-reduce g i f l . ls)

(qmap-reduce-n g i f n)

(qmap-reduce-vector g i f v . vs)

(qequivalence-classes x)

(qtransitive-equivalence-classesp p x)

(qmaximum l)

(qminimum l)

(qmaximump l p)

(qminimump l p)

License

   Copyright 1993-1995 University of Toronto. All rights reserved.
   Copyright 1996 Technion. All rights reserved.
   Copyright 1996 and 1997 University of Vermont. All rights reserved.
   Copyright 1997-2001 NEC Research Institute, Inc. All rights reserved.
   Copyright 2002-2013 Purdue University. All rights reserved.

   Contact Andrei Barbu at [email protected].

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
   You should have received a copy of the GNU Lesser General Public License
   along with this program.  If not, see http://www.gnu.org/licenses.