10.1 Documentation and API conventions

The following conventions for function arguments hold:

bbtree

It is the instance of bbtree the function acts upon. Bbtree arguments are never mutated.

key

The argument is an association key. For all procedures which take a KEY as an argument, the KEY must be comparable with the ordering procedure of the bbtree.

item<

The argument ITEM< must be the ordering procedure: a predicate function accepting two arguments and returning a boolean, #t if the first argument is strictly less than the second. For numeric collected items: ITEM< can be <; for string collected items: ITEM< can be string<?.

This document describes version 0.5.0-devel.1 of MMCK PFDS.