Changeset 25900 in project

Timestamp:

02/14/12 07:14:22 (9 years ago)

Author:

Ivan Raikov

Message:

vlist doc: added hash list procedures

File:

• wiki/eggref/4/vlist (modified) (2 diffs)

wiki/eggref/4/vlist

@@ -30 +30 @@
 since vlist elements are adjacent, which plays well with caches.
 
-=== Procedures
+=== List procedures
 
 
@@ -119 +119 @@
 
 Calls {{proc}} on each element of {{vlist}}.
+
+=== Hash list procedures
+
+Hash vlists are analogous to association lists.
+
+
+<procedure>vhash? obj -> boolean</procedure>
+
+Returns true if {{obj}} is a hash vlist, false otherwise.
+
+<procedure>vhash-cons key value vhash [hash] -> vhash</procedure>
+<procedure>vhash-consq key value vhash [hash] -> vhash</procedure>
+<procedure>vhash-consv key value vhash [hash] -> vhash</procedure>
+
+Return a new hash list based on {{vhash}} where {{key}} is associated with
+{{value}}.  Use {{hash}} to compute {{key}}'s hash.
+
+<procedure>vhash-fold* proc init key vhash -> value</procedure>
+
+Folds over all the values associated with {{key}} in {{vhash}}, with
+each call to {{proc}} having the form {{(proc value result)}}, where
+{{result}} is the result of the previous call to {{proc}} and {{init}}
+the value of {{result}} for the first call to {{proc}}.
+
+<procedure>vhash-foldq* proc init key vhash -> value</procedure>
+
+Same as {{vhash-fold*}}, but using {{eq?-hash}} and {{eq?}}.
+
+<procedure>vhash-foldv* proc init key vhash -> value</procedure>
+
+Same as {{vhash-fold*}}, but using {{eqv?-hash}} and {{eqv?}}.
+
+<procedure>vhash-assoc key vhash [equal?] [hash] -> (key . value)</procedure>
+
+Returns the first key/value pair from {{vhash}} whose key is equal to
+{{key}} according to the {{equal?}} equality predicate.
+
+<procedure>vhash-assq key vhash -> (key . value)</procedure>
+
+Returns the first key/value pair from {{vhash}} whose key is {{eq?}}
+to {{key}}.
+
+<procedure>vhash-assv key vhash -> (key . value)</procedure>
+
+Returns the first key/value pair from {{vhash}} whose key is {{eqv?}}
+to {{key}}.
+
+<procedure>vhash-delete key vhash [equal?] [hash] -> vhash</procedure>
+<procedure>vhash-delq key vhash [equal?] [hash] -> vhash</procedure>
+<procedure>vhash-delv key vhash [equal?] [hash] -> vhash</procedure>
+
+Removes all associations from {{vhash}} with {{key}}, comparing keys
+with {{equal?}}.
+
+
+<procedure>vhash-fold proc init vhash</procedure>
+
+Folds over the key/pair elements of {{vhash}} from left to right, with
+each call to {{proc}} having the form {{({{proc}} key value result)}},
+where {{result}} is the result of the previous call to {{proc}} and
+{{init}} the value of {{result}} for the first call to {{proc}}.
+
+
+<procedure>vhash-fold-right proc init vhash</procedure>
+
+Folds over the key/pair elements of {{vhash}} from right to left, with
+each call to {{proc}} having the form {{({{proc}} key value result)}},
+where {{result}} is the result of the previous call to {{proc}} and
+{{init}} the value of {{result}} for the first call to {{proc}}.
+
+
+<procedure>alist->vhash alist [hash] -> vhash</procedure>
+
+Returns the vhash corresponding to {{alist}}, an association list.
+