summaryrefslogtreecommitdiffstats
path: root/txr.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2017-03-05 10:19:10 -0800
committerKaz Kylheku <kaz@kylheku.com>2017-03-05 10:19:10 -0800
commit266e28cb7129d175ad4af5af5cb45fbbd3054862 (patch)
tree0bffeaab0d67b23e43dd2b85c347f78e67e87f41 /txr.1
parent57ee9921068282f47c0ed91e53a0923e6f08e6e4 (diff)
downloadtxr-266e28cb7129d175ad4af5af5cb45fbbd3054862.tar.gz
txr-266e28cb7129d175ad4af5af5cb45fbbd3054862.tar.bz2
txr-266e28cb7129d175ad4af5af5cb45fbbd3054862.zip
doc: missing description of a group-reduce param.
* txr.1: Describe the filter-fun optional argument of group-reduce.
Diffstat (limited to 'txr.1')
-rw-r--r--txr.118
1 files changed, 16 insertions, 2 deletions
diff --git a/txr.1 b/txr.1
index cf7de0be..9d1422ea 100644
--- a/txr.1
+++ b/txr.1
@@ -36795,11 +36795,25 @@ is invoked with two arguments: the accumulator from step 2, and the
original element from
.metn seq .
.IP 4.
-The resulting value is stored back into the hash table under the
-same key.
+The resulting value from step 3 is stored back into the hash table under the
+key from step 2.
.RE
.IP
+After the above processing, one more step is performed if the
+.meta filter-fun
+argument is present. In this case, the hash table is destructively mapped through
+.meta filter-fun
+before being returned. That is to say, every value in the hash table is
+projected through
+.meta filter-fun
+and stored back in the table under the same key, as if by an invocation the
+.cblk
+.meti (hash-update < hash << filter-fun )
+.cble
+expression.
+
+.IP
If
.code group-reduce
is invoked on an empty hash table, its net result closely resembles a