⟦d67c9122d⟧

E3 Source Code



--| @SUMMARY Provides a table of elements allowing the user to mark
--| them as "used" or not.  Typically the lists is initialized and elements
--| are marked as the satisfy some requirement.
--| @INDICES (MARKING, TABLE_PROCESSING)
--|
with Map_Generic;
generic
    Size : Integer;
    type Element is private;
    with function Hash (Elem : Element) return Integer;
package Element_Usage_Table is

    type Table is private;

    procedure Initialize (The_Table : in out Table);

    --| @DESCRIPTION Adds an element to the table.  Elements are initially
    --| set to be "unused".
    procedure Add (The_Element :        Element;  
                   To          : in out Table);

    --| @DESCRIPTION Resets all elements in the table to "unused"
    procedure Reset (The_Table : in out Table);

    Element_Not_Found : exception;

    --| @RAISES (Element_Not_Found)
    procedure Mark_As_Used (An_Element : Element; In_Table : in out Table);

    --| @RAISES (Element_Not_Found)
    function Is_Used (An_Element : Element;  
                      In_Table   : Table) return Boolean;

    --| @DESCRIPTION Checks to see of all elements in the table are used.
    function All_Used (In_Table : Table) return Boolean;

    type Iterator is private;

    function  Done  (Iter : Iterator) return Boolean;
    function  Value (Iter : Iterator) return Element;
    procedure Next  (Iter : in out Iterator);

private

    package Element_Map is new Map_Generic (Size, Element, Boolean, Hash);

    type Table is new Element_Map.Map;

    type Iterator is new Element_Map.Iterator;

end Element_Usage_Table;
DataMuseum.dk

Rational R1000/400

⟦d67c9122d⟧ Ada Source

Derivation

E3 Source Code

E3 Meta Data
