Table of Contents
A Common Lisp library to help group data into trees (of various formats) based on common/shared values
groups the list into an alist using the key function and value function to group by key, with a list of all values for that key.
key: is used to determine the key in the a-list
value: is used to determine the value in the a-list
key-fn: is passed as the :key to assoc (essentially the key of your key)
test: is passed as the :test to assoc
eg: (group-by '((a 1 2) (a 3 4) (b 5 6)))
=> ((A (1 2) (3 4)) (B (5 6)))
eg: (group-by '((a 1 2) (a 3 4) (b 5 6)) :value #'identity)
=> ((A (A 1 2) (A 3 4)) (B (B 5 6)))
Given a list of input, produce a grouped-list CLOS object that contains the original list, configuration about the groupings and the result tree of grouped-list objects
keys: a list of keys to group by
tests: a list of tests to compare the keys with
grouping-implmentation: What data structure should be used to perform the grouping
The implementation doesnt change the output, but it does change the performance characteristics of the grouped-object (see: grouped-list-speed-tester for help deciding which to use)
For the following docs consider the grouped list (as from examples) grouped-list russ PROJ-A (list of timeclock records) PROJ-B (list of timeclock records) PROJ-C (list of timeclock records) bob PROJ-A (list of timeclock records) PROJ-B (list of timeclock records) PROJ-C (list of timeclock records)
Returns the key-value that this grouped-list represents
nil for the root
the key we are grouping under otherwise
EG: the <gl russ> node returns the string "russ"
Returns the direct child grouped-lists of the current grouped-list
If called on the root grouped list, will return a list of (<gl russ> <gl bob>)
If called on the "russ" grouped list, will return a list of (<gl PROJ-A> <gl PROJ-B> <gl PROJ-C>)
Returns all the items in a grouped list.
key-values:If specified, return only items that match
When called on the root (items-in-group gl) of a grouped-list returns all of the items that list groups (leaf nodes of the tree).
When called as (items-in-group gl "russ" :proj-a) returns the items under the key proj-A that are found under toplevel key "russ"
Sames as group-by, but groups on multiple keys and tests (into an alist tree)
- The examples file contains some examples increasing in complexity
- The tests file also contains running examples
;; Copyright (c) 2011 Russ Tyndall , Acceleration.net http://www.acceleration.net ;; All rights reserved. ;; ;; Redistribution and use in source and binary forms, with or without ;; modification, are permitted provided that the following conditions are ;; met: ;; ;; - Redistributions of source code must retain the above copyright ;; notice, this list of conditions and the following disclaimer. ;; ;; - Redistributions in binary form must reproduce the above copyright ;; notice, this list of conditions and the following disclaimer in the ;; documentation and/or other materials provided with the distribution. ;; ;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT ;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR ;; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT ;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, ;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT ;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, ;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY ;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE ;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.