1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- ADA.CONTAINERS.HASHED_SETS --
9 -- Copyright (C) 2004 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, 59 Temple Place - Suite 330, Boston, --
24 -- MA 02111-1307, 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
;
40 type Element_Type
is private;
42 with function Hash
(Element
: Element_Type
) return Hash_Type
;
44 -- TODO: get a ruling from ARG in Atlanta re the name and
45 -- order of these declarations. ???
47 with function Equivalent_Keys
(Left
, Right
: Element_Type
) return Boolean;
49 with function "=" (Left
, Right
: Element_Type
) return Boolean is <>;
51 package Ada
.Containers
.Hashed_Sets
is
52 pragma Preelaborate
(Hashed_Sets
);
54 type Set
is tagged private;
56 type Cursor
is private;
58 Empty_Set
: constant Set
;
60 No_Element
: constant Cursor
;
62 function "=" (Left
, Right
: Set
) return Boolean;
64 function Length
(Container
: Set
) return Count_Type
;
66 function Is_Empty
(Container
: Set
) return Boolean;
68 procedure Clear
(Container
: in out Set
);
70 function Element
(Position
: Cursor
) return Element_Type
;
72 procedure Query_Element
74 Process
: not null access procedure (Element
: Element_Type
));
76 -- TODO: resolve in atlanta
77 -- procedure Replace_Element
78 -- (Container : in out Set;
80 -- By : Element_Type);
82 procedure Move
(Target
: in out Set
; Source
: in out Set
);
85 (Container
: in out Set
;
86 New_Item
: Element_Type
;
87 Position
: out Cursor
;
88 Inserted
: out Boolean);
90 procedure Insert
(Container
: in out Set
; New_Item
: Element_Type
);
92 procedure Include
(Container
: in out Set
; New_Item
: Element_Type
);
94 procedure Replace
(Container
: in out Set
; New_Item
: Element_Type
);
96 procedure Delete
(Container
: in out Set
; Item
: Element_Type
);
98 procedure Exclude
(Container
: in out Set
; Item
: Element_Type
);
100 procedure Delete
(Container
: in out Set
; Position
: in out Cursor
);
102 procedure Union
(Target
: in out Set
; Source
: Set
);
104 function Union
(Left
, Right
: Set
) return Set
;
106 function "or" (Left
, Right
: Set
) return Set
renames Union
;
108 procedure Intersection
(Target
: in out Set
; Source
: Set
);
110 function Intersection
(Left
, Right
: Set
) return Set
;
112 function "and" (Left
, Right
: Set
) return Set
renames Intersection
;
114 procedure Difference
(Target
: in out Set
; Source
: Set
);
116 function Difference
(Left
, Right
: Set
) return Set
;
118 function "-" (Left
, Right
: Set
) return Set
renames Difference
;
120 procedure Symmetric_Difference
(Target
: in out Set
; Source
: Set
);
122 function Symmetric_Difference
(Left
, Right
: Set
) return Set
;
124 function "xor" (Left
, Right
: Set
) return Set
125 renames Symmetric_Difference
;
127 function Overlap
(Left
, Right
: Set
) return Boolean;
129 function Is_Subset
(Subset
: Set
; Of_Set
: Set
) return Boolean;
131 function Contains
(Container
: Set
; Item
: Element_Type
) return Boolean;
135 Item
: Element_Type
) return Cursor
;
137 function Capacity
(Container
: Set
) return Count_Type
;
139 procedure Reserve_Capacity
140 (Container
: in out Set
;
141 Capacity
: Count_Type
);
143 function First
(Container
: Set
) return Cursor
;
145 function Next
(Position
: Cursor
) return Cursor
;
147 procedure Next
(Position
: in out Cursor
);
149 function Has_Element
(Position
: Cursor
) return Boolean;
151 function Equivalent_Keys
(Left
, Right
: Cursor
) return Boolean;
153 function Equivalent_Keys
155 Right
: Element_Type
) return Boolean;
157 function Equivalent_Keys
158 (Left
: Element_Type
;
159 Right
: Cursor
) return Boolean;
163 Process
: not null access procedure (Position
: Cursor
));
166 type Key_Type
(<>) is limited private;
168 with function Key
(Element
: Element_Type
) return Key_Type
;
170 with function Hash
(Key
: Key_Type
) return Hash_Type
;
172 with function Equivalent_Keys
174 Element
: Element_Type
) return Boolean;
176 package Generic_Keys
is
178 function Contains
(Container
: Set
; Key
: Key_Type
) return Boolean;
180 function Find
(Container
: Set
; Key
: Key_Type
) return Cursor
;
182 function Key
(Position
: Cursor
) return Key_Type
;
184 function Element
(Container
: Set
; Key
: Key_Type
) return Element_Type
;
186 -- TODO: resolve in atlanta
188 -- (Container : in out Set;
190 -- New_Item : Element_Type);
192 procedure Delete
(Container
: in out Set
; Key
: Key_Type
);
194 procedure Exclude
(Container
: in out Set
; Key
: Key_Type
);
196 -- TODO: resolve name in atlanta: ???
197 procedure Checked_Update_Element
198 (Container
: in out Set
;
200 Process
: not null access
201 procedure (Element
: in out Element_Type
));
203 function Equivalent_Keys
205 Right
: Key_Type
) return Boolean;
207 function Equivalent_Keys
209 Right
: Cursor
) return Boolean;
216 type Node_Access
is access Node_Type
;
219 new Hash_Tables
.Generic_Hash_Table_Types
(Node_Access
);
223 type Set
is new Hash_Table_Type
with null record;
225 procedure Adjust
(Container
: in out Set
);
227 procedure Finalize
(Container
: in out Set
);
229 type Set_Access
is access constant Set
;
230 for Set_Access
'Storage_Size use 0;
232 type Cursor
is record
233 Container
: Set_Access
;
237 No_Element
: constant Cursor
:= (Container
=> null, Node
=> null);
242 (Stream
: access Root_Stream_Type
'Class;
245 for Set
'Write use Write
;
248 (Stream
: access Root_Stream_Type
'Class;
249 Container
: out Set
);
251 for Set
'Read use Read
;
253 Empty_Set
: constant Set
:= (Hash_Table_Type
with null record);
255 end Ada
.Containers
.Hashed_Sets
;