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-2006, 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
53 type Set
is tagged private;
54 pragma Preelaborable_Initialization
(Set
);
56 type Cursor
is private;
57 pragma Preelaborable_Initialization
(Cursor
);
59 Empty_Set
: constant Set
;
61 No_Element
: constant Cursor
;
63 function "=" (Left
, Right
: Set
) return Boolean;
65 function Equivalent_Sets
(Left
, Right
: Set
) return Boolean;
67 function To_Set
(New_Item
: Element_Type
) return Set
;
69 function Capacity
(Container
: Set
) return Count_Type
;
71 procedure Reserve_Capacity
72 (Container
: in out Set
;
73 Capacity
: Count_Type
);
75 function Length
(Container
: Set
) return Count_Type
;
77 function Is_Empty
(Container
: Set
) return Boolean;
79 procedure Clear
(Container
: in out Set
);
81 function Element
(Position
: Cursor
) return Element_Type
;
83 procedure Replace_Element
84 (Container
: in out Set
;
86 New_Item
: Element_Type
);
88 procedure Query_Element
90 Process
: not null access procedure (Element
: Element_Type
));
92 procedure Move
(Target
: in out Set
; Source
: in out Set
);
95 (Container
: in out Set
;
96 New_Item
: Element_Type
;
97 Position
: out Cursor
;
98 Inserted
: out Boolean);
100 procedure Insert
(Container
: in out Set
; New_Item
: Element_Type
);
102 procedure Include
(Container
: in out Set
; New_Item
: Element_Type
);
104 procedure Replace
(Container
: in out Set
; New_Item
: Element_Type
);
106 procedure Exclude
(Container
: in out Set
; Item
: Element_Type
);
108 procedure Delete
(Container
: in out Set
; Item
: Element_Type
);
110 procedure Delete
(Container
: in out Set
; Position
: in out Cursor
);
112 procedure Union
(Target
: in out Set
; Source
: Set
);
114 function Union
(Left
, Right
: Set
) return Set
;
116 function "or" (Left
, Right
: Set
) return Set
renames Union
;
118 procedure Intersection
(Target
: in out Set
; Source
: Set
);
120 function Intersection
(Left
, Right
: Set
) return Set
;
122 function "and" (Left
, Right
: Set
) return Set
renames Intersection
;
124 procedure Difference
(Target
: in out Set
; Source
: Set
);
126 function Difference
(Left
, Right
: Set
) return Set
;
128 function "-" (Left
, Right
: Set
) return Set
renames Difference
;
130 procedure Symmetric_Difference
(Target
: in out Set
; Source
: Set
);
132 function Symmetric_Difference
(Left
, Right
: Set
) return Set
;
134 function "xor" (Left
, Right
: Set
) return Set
135 renames Symmetric_Difference
;
137 function Overlap
(Left
, Right
: Set
) return Boolean;
139 function Is_Subset
(Subset
: Set
; Of_Set
: Set
) return Boolean;
141 function First
(Container
: Set
) return Cursor
;
143 function Next
(Position
: Cursor
) return Cursor
;
145 procedure Next
(Position
: in out Cursor
);
149 Item
: Element_Type
) return Cursor
;
151 function Contains
(Container
: Set
; Item
: Element_Type
) return Boolean;
153 function Has_Element
(Position
: Cursor
) return Boolean;
155 function Equivalent_Elements
(Left
, Right
: Cursor
) return Boolean;
157 function Equivalent_Elements
159 Right
: Element_Type
) return Boolean;
161 function Equivalent_Elements
162 (Left
: Element_Type
;
163 Right
: Cursor
) return Boolean;
167 Process
: not null access procedure (Position
: Cursor
));
170 type Key_Type
(<>) is private;
172 with function Key
(Element
: Element_Type
) return Key_Type
;
174 with function Hash
(Key
: Key_Type
) return Hash_Type
;
176 with function Equivalent_Keys
(Left
, Right
: Key_Type
) return Boolean;
178 package Generic_Keys
is
180 function Key
(Position
: Cursor
) return Key_Type
;
182 function Element
(Container
: Set
; Key
: Key_Type
) return Element_Type
;
185 (Container
: in out Set
;
187 New_Item
: Element_Type
);
189 procedure Exclude
(Container
: in out Set
; Key
: Key_Type
);
191 procedure Delete
(Container
: in out Set
; Key
: Key_Type
);
193 function Find
(Container
: Set
; Key
: Key_Type
) return Cursor
;
195 function Contains
(Container
: Set
; Key
: Key_Type
) return Boolean;
197 procedure Update_Element_Preserving_Key
198 (Container
: in out Set
;
200 Process
: not null access
201 procedure (Element
: in out Element_Type
));
207 type Node_Access
is access Node_Type
;
211 Element
: Element_Type
;
215 package HT_Types
is new Hash_Tables
.Generic_Hash_Table_Types
219 type Set
is new Ada
.Finalization
.Controlled
with record
220 HT
: HT_Types
.Hash_Table_Type
;
223 procedure Adjust
(Container
: in out Set
);
225 procedure Finalize
(Container
: in out Set
);
228 use Ada
.Finalization
;
231 type Set_Access
is access all Set
;
232 for Set_Access
'Storage_Size use 0;
236 Container
: Set_Access
;
241 (Stream
: access Root_Stream_Type
'Class;
244 for Cursor
'Write use Write
;
247 (Stream
: access Root_Stream_Type
'Class;
250 for Cursor
'Read use Read
;
252 No_Element
: constant Cursor
:= (Container
=> null, Node
=> null);
255 (Stream
: access Root_Stream_Type
'Class;
258 for Set
'Write use Write
;
261 (Stream
: access Root_Stream_Type
'Class;
262 Container
: out Set
);
264 for Set
'Read use Read
;
266 Empty_Set
: constant Set
:= (Controlled
with HT
=> (null, 0, 0, 0));
268 end Ada
.Containers
.Hashed_Sets
;