1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . H A S H E D _ S E T S --
9 -- Copyright (C) 2004-2007, Free Software Foundation, Inc. --
11 -- This specification is derived from the Ada Reference Manual for use with --
12 -- GNAT. The copyright notice above, and the license provisions that follow --
13 -- apply solely to the contents of the part following the private keyword. --
15 -- GNAT is free software; you can redistribute it and/or modify it under --
16 -- terms of the GNU General Public License as published by the Free Soft- --
17 -- ware Foundation; either version 2, or (at your option) any later ver- --
18 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
19 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
20 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
21 -- for more details. You should have received a copy of the GNU General --
22 -- Public License distributed with GNAT; see file COPYING. If not, write --
23 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
24 -- Boston, MA 02110-1301, USA. --
26 -- As a special exception, if other files instantiate generics from this --
27 -- unit, or you link this unit with other files to produce an executable, --
28 -- this unit does not by itself cause the resulting executable to be --
29 -- covered by the GNU General Public License. This exception does not --
30 -- however invalidate any other reasons why the executable file might be --
31 -- covered by the GNU Public License. --
33 -- This unit was originally developed by Matthew J Heaney. --
34 ------------------------------------------------------------------------------
36 with Ada.Containers.Hash_Tables;
38 with Ada.Finalization;
41 type Element_Type is private;
43 with function Hash (Element : Element_Type) return Hash_Type;
45 with function Equivalent_Elements (Left, Right : Element_Type)
48 with function "=" (Left, Right : Element_Type) return Boolean is <>;
50 package Ada.Containers.Hashed_Sets is
54 type Set is tagged private;
55 pragma Preelaborable_Initialization (Set);
57 type Cursor is private;
58 pragma Preelaborable_Initialization (Cursor);
60 Empty_Set : constant Set;
62 No_Element : constant Cursor;
64 function "=" (Left, Right : Set) return Boolean;
66 function Equivalent_Sets (Left, Right : Set) return Boolean;
68 function To_Set (New_Item : Element_Type) return Set;
70 function Capacity (Container : Set) return Count_Type;
72 procedure Reserve_Capacity
73 (Container : in out Set;
74 Capacity : Count_Type);
76 function Length (Container : Set) return Count_Type;
78 function Is_Empty (Container : Set) return Boolean;
80 procedure Clear (Container : in out Set);
82 function Element (Position : Cursor) return Element_Type;
84 procedure Replace_Element
85 (Container : in out Set;
87 New_Item : Element_Type);
89 procedure Query_Element
91 Process : not null access procedure (Element : Element_Type));
93 procedure Move (Target : in out Set; Source : in out Set);
96 (Container : in out Set;
97 New_Item : Element_Type;
98 Position : out Cursor;
99 Inserted : out Boolean);
101 procedure Insert (Container : in out Set; New_Item : Element_Type);
103 procedure Include (Container : in out Set; New_Item : Element_Type);
105 procedure Replace (Container : in out Set; New_Item : Element_Type);
107 procedure Exclude (Container : in out Set; Item : Element_Type);
109 procedure Delete (Container : in out Set; Item : Element_Type);
111 procedure Delete (Container : in out Set; Position : in out Cursor);
113 procedure Union (Target : in out Set; Source : Set);
115 function Union (Left, Right : Set) return Set;
117 function "or" (Left, Right : Set) return Set renames Union;
119 procedure Intersection (Target : in out Set; Source : Set);
121 function Intersection (Left, Right : Set) return Set;
123 function "and" (Left, Right : Set) return Set renames Intersection;
125 procedure Difference (Target : in out Set; Source : Set);
127 function Difference (Left, Right : Set) return Set;
129 function "-" (Left, Right : Set) return Set renames Difference;
131 procedure Symmetric_Difference (Target : in out Set; Source : Set);
133 function Symmetric_Difference (Left, Right : Set) return Set;
135 function "xor" (Left, Right : Set) return Set
136 renames Symmetric_Difference;
138 function Overlap (Left, Right : Set) return Boolean;
140 function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
142 function First (Container : Set) return Cursor;
144 function Next (Position : Cursor) return Cursor;
146 procedure Next (Position : in out Cursor);
150 Item : Element_Type) return Cursor;
152 function Contains (Container : Set; Item : Element_Type) return Boolean;
154 function Has_Element (Position : Cursor) return Boolean;
156 function Equivalent_Elements (Left, Right : Cursor) return Boolean;
158 function Equivalent_Elements
160 Right : Element_Type) return Boolean;
162 function Equivalent_Elements
163 (Left : Element_Type;
164 Right : Cursor) return Boolean;
168 Process : not null access procedure (Position : Cursor));
171 type Key_Type (<>) is private;
173 with function Key (Element : Element_Type) return Key_Type;
175 with function Hash (Key : Key_Type) return Hash_Type;
177 with function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
179 package Generic_Keys is
181 function Key (Position : Cursor) return Key_Type;
183 function Element (Container : Set; Key : Key_Type) return Element_Type;
186 (Container : in out Set;
188 New_Item : Element_Type);
190 procedure Exclude (Container : in out Set; Key : Key_Type);
192 procedure Delete (Container : in out Set; Key : Key_Type);
194 function Find (Container : Set; Key : Key_Type) return Cursor;
196 function Contains (Container : Set; Key : Key_Type) return Boolean;
198 procedure Update_Element_Preserving_Key
199 (Container : in out Set;
201 Process : not null access
202 procedure (Element : in out Element_Type));
208 pragma Inline (Next);
211 type Node_Access is access Node_Type;
215 Element : Element_Type;
219 package HT_Types is new Hash_Tables.Generic_Hash_Table_Types
223 type Set is new Ada.Finalization.Controlled with record
224 HT : HT_Types.Hash_Table_Type;
227 procedure Adjust (Container : in out Set);
229 procedure Finalize (Container : in out Set);
232 use Ada.Finalization;
235 type Set_Access is access all Set;
236 for Set_Access'Storage_Size use 0;
240 Container : Set_Access;
245 (Stream : not null access Root_Stream_Type'Class;
248 for Cursor'Write use Write;
251 (Stream : not null access Root_Stream_Type'Class;
254 for Cursor'Read use Read;
256 No_Element : constant Cursor := (Container => null, Node => null);
259 (Stream : not null access Root_Stream_Type'Class;
262 for Set'Write use Write;
265 (Stream : not null access Root_Stream_Type'Class;
266 Container : out Set);
268 for Set'Read use Read;
270 Empty_Set : constant Set := (Controlled with HT => (null, 0, 0, 0));
272 end Ada.Containers.Hashed_Sets;