API Documentation: Purely Functional Data Structures

Returns an empty bounded balance tree.

Returns #t if the object is a bounded balance tree instance.

Returns the number of elements in the bounded balance tree.

Returns the value associated with the key in the bounded balance tree. If the key is not in the tree then the optional default value is returned or, if not present, an error is raised.

Returns a new bounded balance tree with the key associated with the value. If the key is already in the bounded balance tree, its associated value is replaced with the new value in the returned bounded balance tree.

Returns a new bounded balance tree with the value associated with the key updated according to the update procedure. If the key was not already in the bounded balance tree, the update procedure is called on the default value, and the association is added to the bounded balance tree.

Returns a new bounded balance tree with the key and its associated value removed. If the key is not in the bounded balance tree, then the returned tree is a copy of the original.

Returns #t if there is an association for the given key in the bounded balance tree, #f otherwise.

Returns the ordering procedure used internally to order the bounded balance tree.

A general tree traversal procedure. Returns the value of applying the traverser procedure to the current node’s key, value, a procedure to traverse the left subtree, a procedure to traverse the right subtree, and a base value. The subtree traversal procedures both take a base argument, and call bbtree-traverse recursively on the appropriate subtree. It is mostly useful for implementing other, more specific tree traversal procedures.

Returns the value obtained by the iterating the combine procedure over each node in the tree. The combine procedure takes three arguments, the key and value of the current node, and an accumulator value, and its return value is used as the accumulator value for the next node. The initial accumulator value is provided by the base argument. bbtree-fold performs an left-to-right in-order traversal or "minimum key to maximum key".

Returns the value obtained by the iterating the combine procedure over each node in the tree. The combine procedure takes three arguments, the key and value of the current node, and an accumulator value, and its return value is used as the accumulator value for the next node. The initial accumulator value is provided by the base argument. bbtree-fold performs a right-to-left in-order traversal or "maximum key to minimum key".

Returns the tree obtained by updating the value of each node with the result of applying the mapping procedure to its value.

Returns the key-value associations of the bounded balance tree as a list of pairs. The list returned is in sorted order, according to the ordering procedure of the bounded balance tree.

Returns a bounded balance tree containing each of the key-value pairs in the association list, using the given comparison procedure for ordering.

Returns a list containing all the keys of the bounded balance tree. The keys are sorted according to the bounded balance tree’s ordering procedure.

Returns a bounded balance tree containing the union of the assications in the two trees. The ordering procedure from bbtree-1 is used in the result, and duplicate keys are given the value in bbtree-1.

Returns a bounded balance tree containing all of the assications in bbtree-1 which do not occur in bbtree-2.

Returns a bounded balance tree containing all of the associations which appear in both bbtree-1 and bbtree-2; the value in bbtree-1 is preferred over that in bbtree-2.

Returns the index of the key in the bounded balance tree. Index is an integer between 0 and size-1, with a key having a lower index than a second if first-key < second-key, according to the bounded balance tree ordering procedure.

Returns the key and value of the association in the bounded balance tree at the given index.

Returns #t if object is a deque.

Returns the number of items in the deque.

Returns #t if there are no items in the deque.

Returns a new deque with the inserted item at the front.

Returns a new deque with the inserted item at the rear.

Returns two values, the item at the front of the deque, and a new deque containing all the other items.

Returns two values, the item at the rear of the deque, and a new deque containing all the other items.

Returns a list containing all the elements of the deque, in the order they would be in if dequeued from the front of the deque.

Returns a deque containing all of the elements in the list in order.

Returns a difference list containing all the given elements.

Returns #t if object is a difference list.

Returns a new difference list created by prepending the given element to the head of the difference list.

Returns a new difference list created by appending the given element to the tail of the difference list.

Returns a new difference list consisting of all the elements of dlist-1 followed by all the elements of dlist-2.

Returns a list consisting of all the elements of the difference list.

Returns a difference list consisting of all the elements of the list.

Returns a fector of the specified size. If fill is provided, then the locations of the fector are initialised to that object.

Returns a fector whose initial values are the given elements.

Returns #t if object is a fector instance.

Returns the number of elements that are stored in the fector.

Returns a new fector of the given size, where each element is initialised to the value of the given procedure applied to its index.

Returns the value associated with the given index in the fector.

Returns a new fector equivalent to the given one except the given index is now associated with the given element.

Returns a fector initialised with the contents of the given list.

Returns a list containing the elements in a given fector.

Returns #t if object is a fingertree.

Returns #t if there are no items in the given fingertree.

Returns a new fingertree, parameterised by the given monoid.

Returns a new fingertree created by adding the given element to the front of the given fingertree.

Returns a new fingertree created by adding the given element to the end of the given fingertree.

Returns two values: the element at the front of the fingertree, and a new fingertree containing all but the front element.

Returns two values: a new fingertree containing all but the rear element, and the element at the rear of the fingertree.

Returns a new fingertree which contains all of the elements of the first fingertree, followed by all the elements of the second. The two fingertrees are assumed to be parameterised by the same monoid.

Returns a new fingertree containing all the elements of the given list, parameterised by the given three procedures.

Returns a list of all the elements in the fingertree, in the order in which they would be unconsed.

Returns the measure of the given fingertree.

Returns two values: the first is the largest prefix of the fingertree for which applying the predicate to its accumulated measure returns #f. The second value is a fingertree containing all those elements not in the first fingertree.

Returns three values: the first is the largest prefix of the fingertree for which applying the predicate to its accumulated measure returns #f. The second value is the head of those elements not in the first fingertree, and the third value is a fingertree containing the tail.

Returns the value obtained by iterating the combiner procedure over the fingertree in left-to-right order.

Returns the value obtained by iterating the combiner procedure over the fingertree in right-to-left order.

Returns a new fingertree in which the elements are in the opposite order from the given fingertree.

Returns a new empty hamt using the given hash and equivalence functions.

Returns #t if the object is a hamt instance.

Returns the number of associations in the hamt.

Returns the value associated with the key in the hamt. If there is no value associated with the key, returns default, if given, or raises error, if not.

Returns a new hamt with the key assiciated to the value. If the key is already associated with a value, it is replaced.

Returns a new hamt with the value associated with the key updated by the update procedure. If the hamt does not have a value associated with the key, then the update procedure is applied to the default value, and the association added.

Returns a new hamt with the key and its associated value removed. If the key is not in the hamt, returns a copy of the original hamt.

Returns #t if there is an association for the key in the hamt, or #f otherwise.

Returns the procedure used internally by the hamt to compare keys.

Returns the hash procedure used internally by the hamt.

Returns value obtained by iterating the combine procedure over each key-value pair in the hamt. The traversal order is not guaranteed.

Returns a new hamt obtained by applying the update procedure to each of the values in the hamt.

Returns the key/value associations of the hamt as a list of pairs. The order of the list is not guaranteed.

Returns a new hamt using the given hash and equivalence functions, filled with the key-value pairs. Repeated keys will have the left-most value.

Returns a new empty heap using the ordering procedure.

Returns a new heap, using the ordering procedure, containing the given values as elements.

Returns #t if the object is a heap instance.

Returns the number of elements in the heap.

Returns #t if the heap contains no elements.

Returns the minimum element in the heap, according to the heap’s ordering procedure.

Returns a new heap containing all the elements of the heap except for the minimum element, according to the heap’s ordering procedure.

Returns a new heap obtained by adding the given value to those in the heap.

Returns two values, the minimum value in the heap, and a new heap obtained by removing the minimum value from the original heap.

Returns a list containing all the elements of the heap. The list is ordered according to the heap’s ordering procedure.

Returns a heap containing all the elements of the list using the ordering procedure.

Returns a new heap containing all the elements from the given two heaps. The heaps are assumed to be using the same ordering procedure.

Returns a new list that is a permutation of the given list, using the ordering procedure.

Returns the heap ordering procedure.

Returns an empty priority search queue.

Returns #t if the object is a priority search queue instance.

Returns #t if the priority search queue contains no elements.

Returns the priority of a key if it is in the priority search queue.

Returns the priority search queue obtained from inserting a key with the given priority. If the key is already in the priority search queue, then its priority alue is updated.

Returns the priority search queue obtained by modifying the priority of a key by the given function. If the key is not in the priority search queue, then it is inserted with the priority obtained by calling the function on the default value.

Returns the priority search queue obtained by removing the key-priority association from the priority search queue. If the key is not in the queue, then the returned search queue will be the same as the original.

Returns #t if there is an association for the given key in the priority search queue, #f otherwise.

Returns the key of the minimum association in the priority search queue.

Returns the priority search queue obtained by removing the minimum association in the priority search queue.

Returns two values: the minimum key and the priority search queue obtained by removing the minimum association from the original queue.

Returns an alist containing all the associations in the priority search queue with priority less than or equal to a given value. The alist returned is ordered by key according to the predicate for the psq.

Returns an alist containing all the associations in the priority search queue with priority less than or equal to a given value, with keys withing the given (inclusive) bounds. The alist returned is ordered by key according to the predicate for the psq.

Returns #t if object is a queue.

Returns the number of items in the queue.

Returns #t if the queue is empty.

Returns a new queue with the enqueued item at the end.

Returns two values, the item at the front of the queue, and a new queue containing all the other items.

Returns a queue containing all of the elements in the list in order.

Returns a list containing all the elements of the queue, in the order they would be in if dequeued from the front of the queue.

Returns #t if the object is a sequence.

Returns #t if the sequence contains no elements.

Returns the number of elements in the sequence.

Returns a new sequence created by adding the value to the front of the sequence.

Returns two values, the first element of the sequence and a new sequence containing all but the first element.

Returns a new sequence created by adding the value to the end of the sequence.

Returns two values, a new sequence containing all but the last element and the last element itself.

Returns a new sequence containing all the elements of the first sequence followed by all the elements of the second sequence.

Returns a new sequence containing all the elements of the argument list, in the same order.

Returns a new list containing all the elements of the sequence, in the same order.

Returns a new sequence containing all the argument elements, in the same order.

Returns two values, the first containing the first i elements of the sequence, and the second containing the remaining elements. If i is negative, returns an empty sequence and the original sequence. If i is greater than the sequence length, returns the original sequence and an empty sequence.

Returns a new sequence containing the first i elements of the sequence. If i is negative, returns the empty sequence. If i is greater than the sequence length, returns the whole sequence.

Returns a new sequence containing all but the first i elements of the sequence. If i is negative, returns the whole sequence. If i is greater than the sequence length, returns the empty sequence.

Returns the element at the specified index in the sequence.

Returns a new sequence with the element at the specified index in the sequence replaced by the given object.

Returns the value obtained by iterating the combiner procedure over the sequence in left-to-right order.

Returns the value obtained by iterating the combiner procedure over the sequence in right-to-left order.

Returns a new sequence containing all the elements of the sequence in reverse order.

Returns a new sequence obtained by applying the procedure to each element of the sequence in turn.

Returns a new sequence containing all the elements for which the predicate is true.

Returns #t if object is a set instance.

Returns a new empty set ordered by the element<? procedure.

Returns #t if the element is in the set.

Returns a new set created by inserting element into the given set.

Returns a new set created by removing element from the given set.

Returns the number of elements in the set.

Returns #t if set-1 is a proper subset of set-2, #f otherwise.

Returns #t if set-1 is a subset of set-2, #f otherwise.

Returns #t if every element of set-1 is in set-2 and vice-versa, #f otherwise.

Returns #t if set-2 is a subset of set-1, #f otherwise.

Returns #t if set-2 is a proper subset of set-1, #f otherwise.

Returns #t if set-1 is a subset of set-2, #f otherwise.

Returns #t if set-1 is a proper subset of set-2, #f otherwise.

Returns a new set created by applying the given proc to each element of the set.

Returns the value obtained by iterating the procedure over each element of the set and an accumulator value.

Returns a set containing all the elements of the list, ordered by element<?.

Returns all the elements of the set as a list.

Returns the set containing the union of the two given sets, i.e. all the elements in set-1 and set-2.

Returns the set containing the intersection of the two given sets, i.e. all the elements that are in both set-1 and set-2.

Returns the set containing the difference of the two given sets, i.e. all the elements in set-1 that are not in set-2.

Returns the ordering procedure used internally by the set.