23.2 Conventions

All the functions are exported by the (vicare containers lists) library, while all the macros are exported by (vicare containers lists stx). Each macro has a corresponding function version, but some functions were not translated to macros. Macro names always end with the suffix ‘/stx’.

It is an error to pass a circular or dotted list to a procedure not defined to accept such an argument; it is an error to pass a proper or dotted list to a procedure defined for circular lists.

All the functions and macros whose main name ends with ‘!’, are allowed to alter their arguments.

The documentation of this library obeys the following conventions for procedure formals:

ell

A proper (finite, nil–terminated) list.

circ

A proper or circular list.

dotted

A dotted list.

pair

A pair.

n

i

A non–negative exact integer object.

proc

A procedure.

pred

A procedure whose return value is treated as a boolean.

item=

A boolean procedure taking two arguments.

fill

Can be any value; it is used to indicate values used to fill a compound data structure.

obj

Any value, including dotted lists.