diff options
Diffstat (limited to 'gcc/ada/a-chtgke.ads')
-rw-r--r-- | gcc/ada/a-chtgke.ads | 33 |
1 files changed, 26 insertions, 7 deletions
diff --git a/gcc/ada/a-chtgke.ads b/gcc/ada/a-chtgke.ads index 259b0126df2..833976acace 100644 --- a/gcc/ada/a-chtgke.ads +++ b/gcc/ada/a-chtgke.ads @@ -9,10 +9,6 @@ -- -- -- Copyright (C) 2004-2006, Free Software Foundation, Inc. -- -- -- --- This specification is derived from the Ada Reference Manual for use with -- --- GNAT. The copyright notice above, and the license provisions that follow -- --- apply solely to the contents of the part following the private keyword. -- --- -- -- GNAT is free software; you can redistribute it and/or modify it under -- -- terms of the GNU General Public License as published by the Free Soft- -- -- ware Foundation; either version 2, or (at your option) any later ver- -- @@ -34,6 +30,9 @@ -- This unit was originally developed by Matthew J Heaney. -- ------------------------------------------------------------------------------ +-- Hash_Table_Type is used to implement hashed containers. This package +-- declares hash-table operations that depend on keys. + generic with package HT_Types is new Generic_Hash_Table_Types (<>); @@ -61,13 +60,18 @@ package Ada.Containers.Hash_Tables.Generic_Keys is (HT : Hash_Table_Type; Key : Key_Type) return Hash_Type; pragma Inline (Index); + -- Returns the bucket number (array index value) for the given key procedure Delete_Key_Sans_Free - (HT : in out Hash_Table_Type; - Key : Key_Type; - X : out Node_Access); + (HT : in out Hash_Table_Type; + Key : Key_Type; + X : out Node_Access); + -- Removes the node (if any) with the given key from the hash table, + -- without deallocating it. Program_Error is raised if the hash + -- table is busy. function Find (HT : Hash_Table_Type; Key : Key_Type) return Node_Access; + -- Returns the node (if any) corresponding to the given key generic with function New_Node (Next : Node_Access) return Node_Access; @@ -76,6 +80,11 @@ package Ada.Containers.Hash_Tables.Generic_Keys is Key : Key_Type; Node : out Node_Access; Inserted : out Boolean); + -- Attempts to insert a new node with the given key into the hash table. + -- If a node with that key already exists in the table, then that node + -- is returned and Inserted returns False. Otherwise New_Node is called + -- to allocate a new node, and Inserted returns True. Program_Error is + -- raised if the hash table is busy. generic with function Hash (Node : Node_Access) return Hash_Type; @@ -84,5 +93,15 @@ package Ada.Containers.Hash_Tables.Generic_Keys is (HT : in out Hash_Table_Type; Node : Node_Access; Key : Key_Type); + -- Assigns Key to Node, possibly changing its equivalence class. If Node + -- is in the same equivalence class as Key (that is, it's already in the + -- bucket implied by Key), then if the hash table is locked then + -- Program_Error is raised; otherwise Assign is called to assign Key to + -- Node. If Node is in a different bucket from Key, then Program_Error is + -- raised if the hash table is busy. Otherwise it Assigns Key to Node and + -- moves the Node from its current bucket to the bucket implied by Key. + -- Note that it is never proper to assign to Node a key value already + -- in the map, and so if Key is equivalent to some other node then + -- Program_Error is raised. end Ada.Containers.Hash_Tables.Generic_Keys; |