This site is a static rendering of the Trac instance that was used by R7RS-WG1 for its work on R7RS-small (PDF), which was ratified in 2013. For more information, see Home. For a version of this page that may be more recent, see EnumContainersCowan in WG2's repo for R7RS-large.

Enum­Containers­Cowan

cowan
2014-11-05 06:01:36
6history
source

THIS IS NOT A PROPOSAL. It's just a dumping ground for some stuff I don't want to lose track of. There will be a proper proposal later.

Enumerations

Based on unique objects, not symbols.

Each enum object has four properties: enum type, name (a symbol), ordinal (a non-negative exact integer), value (anything). Enum objects are unique across enum types. Names and ordinals are unique within an enum type. Accessors are enum-type, enum-name, enum-ordinal, enum-value.

An enum type contains a map from names to enum objects and a vector indexed by the ordinal. We need enum-ordinal->enum (uses the vector) and enum-name->enum (uses the map) as fundamental procedures on enum types. Simple composition gives us enum-name->ordinal, enum-ordinal->name, enum-ordinal->value, and enum->name->value. There is no way to work backward from an enum value because it need not be unique. To step from one enum to another, enum-next and enum-prev.

Having a single value is very handy for C definitions, etc.

Operations over the whole enum-type: enum-type-size, enum-type-enums and enum-type-names. Maybe enum-type-values as well.

Make-enumeration-type accepts either names or (name value) lists. Ordinals are assigned in order from 0 upward; values default to same as ordinals. Define-enumeration-type binds an identifier to the enumeration type and an identifier per enum (same as the name) to each enum.

Enumeration sets

Except as noted below, the procedures for creating and manipulating enumeration sets are the same as those for sets, except that set is replaced by enum-set in their names. Wherever a newly allocated enumeration set is returned, it has the same enumeration type as the source sets. It is an error to operate on enumeration sets of different types in a single procedure.

(universal-enum-set enum-type)

Returns a newly allocated enumeration set. The possible elements of the set are the enum objects in enum-type. The set contains all possible elements. The approximate R6RS equivalent is enum-set-universe.

(enum-set enum-type element ...)

Returns a newly allocated enumeration set. The possible elements of the set are the symbols in enum-type. The set is initialized to contain the elements. There is no R6RS equivalent.

(list->enum-set enum-type list)

Returns a newly allocated enumeration set. The possible elements of the set are the symbols in enum-type. The set is initialized to contain the elements of list. There is no R6RS equivalent.

(enum-set-complement enum-set)

Returns a newly allocated enumeration set that is the complement of enum-set. This procedure is also in R6RS.

(enum-set-projection enum-set enum-type)

Returns a newly allocated enumeration set of type enum-type. Its elements are the enum objects in enum-type which have the same names as members of enum-set. Enum objects without corresponding names are ignored. This procedure is also in R6RS, but uses a second enum-set in place of enum-type.

There will probably be more, depending on how integer sets turn out: enum-set-complement, enum-set-complement!, enum-set-min, enum-set-max.

Enumeration maps

Based on vectors indexed by the enum's ordinal. Procedures:

Constructors make-enum-map enum-map enum-map-unfold Predicates enum-map? enum-map-contains? enum-map=? Accessors enum-map-ref enum-map-ref/default Mutators enum-map-set! enum-map-set-entries! enum-map-delete! enum-map-delete-keys! enum-map-extend! enum-map-extend!/default enum-map-replace! enum-map-replace!/default enum-map-update! enum-map-updated!/default enum-map-push! enum-map-pop! enum-map-search! enum-map-clear! The whole enum map enum-map-size enum-map-keys enum-map-values enum-map-entries enum-map-find enum-map-count enum-map-any enum-map-every enum-map-map enum-map-map-values enum-map-for-each enum-map-map! enum-map-collect enum-map-fold enum-map-filter! enum-map-remove! Copying and conversion enum-map-copy enum-map->alist Enum maps as functions enum-map-accessor enum-map-accessor/default enum-map-union enum-map-intersection enum-map-difference enum-map-xor