1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . --
6 -- I N D E F I N I T E _ O R D E R E D _ S E T S --
10 -- Copyright (C) 2004-2007, Free Software Foundation, Inc. --
12 -- This specification is derived from the Ada Reference Manual for use with --
13 -- GNAT. The copyright notice above, and the license provisions that follow --
14 -- apply solely to the contents of the part following the private keyword. --
16 -- GNAT is free software; you can redistribute it and/or modify it under --
17 -- terms of the GNU General Public License as published by the Free Soft- --
18 -- ware Foundation; either version 2, or (at your option) any later ver- --
19 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
20 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
21 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
22 -- for more details. You should have received a copy of the GNU General --
23 -- Public License distributed with GNAT; see file COPYING. If not, write --
24 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
25 -- Boston, MA 02110-1301, USA. --
27 -- As a special exception, if other files instantiate generics from this --
28 -- unit, or you link this unit with other files to produce an executable, --
29 -- this unit does not by itself cause the resulting executable to be --
30 -- covered by the GNU General Public License. This exception does not --
31 -- however invalidate any other reasons why the executable file might be --
32 -- covered by the GNU Public License. --
34 -- This unit was originally developed by Matthew J Heaney. --
35 ------------------------------------------------------------------------------
37 with Ada.Containers.Red_Black_Trees;
38 with Ada.Finalization;
42 type Element_Type (<>) is private;
44 with function "<" (Left, Right : Element_Type) return Boolean is <>;
45 with function "=" (Left, Right : Element_Type) return Boolean is <>;
47 package Ada.Containers.Indefinite_Ordered_Sets is
51 function Equivalent_Elements (Left, Right : Element_Type) return Boolean;
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 Length (Container : Set) return Count_Type;
71 function Is_Empty (Container : Set) return Boolean;
73 procedure Clear (Container : in out Set);
75 function Element (Position : Cursor) return Element_Type;
77 procedure Replace_Element
78 (Container : in out Set;
80 New_Item : Element_Type);
82 procedure Query_Element
84 Process : not null access procedure (Element : Element_Type));
86 procedure Move (Target : in out Set; Source : in out Set);
89 (Container : in out Set;
90 New_Item : Element_Type;
91 Position : out Cursor;
92 Inserted : out Boolean);
95 (Container : in out Set;
96 New_Item : Element_Type);
99 (Container : in out Set;
100 New_Item : Element_Type);
103 (Container : in out Set;
104 New_Item : Element_Type);
107 (Container : in out Set;
108 Item : Element_Type);
111 (Container : in out Set;
112 Item : Element_Type);
115 (Container : in out Set;
116 Position : in out Cursor);
118 procedure Delete_First (Container : in out Set);
120 procedure Delete_Last (Container : in out Set);
122 procedure Union (Target : in out Set; Source : Set);
124 function Union (Left, Right : Set) return Set;
126 function "or" (Left, Right : Set) return Set renames Union;
128 procedure Intersection (Target : in out Set; Source : Set);
130 function Intersection (Left, Right : Set) return Set;
132 function "and" (Left, Right : Set) return Set renames Intersection;
134 procedure Difference (Target : in out Set; Source : Set);
136 function Difference (Left, Right : Set) return Set;
138 function "-" (Left, Right : Set) return Set renames Difference;
140 procedure Symmetric_Difference (Target : in out Set; Source : Set);
142 function Symmetric_Difference (Left, Right : Set) return Set;
144 function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
146 function Overlap (Left, Right : Set) return Boolean;
148 function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
150 function First (Container : Set) return Cursor;
152 function First_Element (Container : Set) return Element_Type;
154 function Last (Container : Set) return Cursor;
156 function Last_Element (Container : Set) return Element_Type;
158 function Next (Position : Cursor) return Cursor;
160 procedure Next (Position : in out Cursor);
162 function Previous (Position : Cursor) return Cursor;
164 procedure Previous (Position : in out Cursor);
166 function Find (Container : Set; Item : Element_Type) return Cursor;
168 function Floor (Container : Set; Item : Element_Type) return Cursor;
170 function Ceiling (Container : Set; Item : Element_Type) return Cursor;
172 function Contains (Container : Set; Item : Element_Type) return Boolean;
174 function Has_Element (Position : Cursor) return Boolean;
176 function "<" (Left, Right : Cursor) return Boolean;
178 function ">" (Left, Right : Cursor) return Boolean;
180 function "<" (Left : Cursor; Right : Element_Type) return Boolean;
182 function ">" (Left : Cursor; Right : Element_Type) return Boolean;
184 function "<" (Left : Element_Type; Right : Cursor) return Boolean;
186 function ">" (Left : Element_Type; Right : Cursor) return Boolean;
190 Process : not null access procedure (Position : Cursor));
192 procedure Reverse_Iterate
194 Process : not null access procedure (Position : Cursor));
197 type Key_Type (<>) is private;
199 with function Key (Element : Element_Type) return Key_Type;
201 with function "<" (Left, Right : Key_Type) return Boolean is <>;
203 package Generic_Keys is
205 function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
207 function Key (Position : Cursor) return Key_Type;
209 function Element (Container : Set; Key : Key_Type) return Element_Type;
212 (Container : in out Set;
214 New_Item : Element_Type);
216 procedure Exclude (Container : in out Set; Key : Key_Type);
218 procedure Delete (Container : in out Set; Key : Key_Type);
222 Key : Key_Type) return Cursor;
226 Key : Key_Type) return Cursor;
230 Key : Key_Type) return Cursor;
234 Key : Key_Type) return Boolean;
236 procedure Update_Element_Preserving_Key
237 (Container : in out Set;
239 Process : not null access
240 procedure (Element : in out Element_Type));
246 pragma Inline (Next);
247 pragma Inline (Previous);
250 type Node_Access is access Node_Type;
252 type Element_Access is access Element_Type;
254 type Node_Type is limited record
255 Parent : Node_Access;
258 Color : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
259 Element : Element_Access;
262 package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
266 type Set is new Ada.Finalization.Controlled with record
267 Tree : Tree_Types.Tree_Type;
270 procedure Adjust (Container : in out Set);
272 procedure Finalize (Container : in out Set) renames Clear;
276 use Ada.Finalization;
279 type Set_Access is access all Set;
280 for Set_Access'Storage_Size use 0;
282 type Cursor is record
283 Container : Set_Access;
288 (Stream : not null access Root_Stream_Type'Class;
291 for Cursor'Write use Write;
294 (Stream : not null access Root_Stream_Type'Class;
297 for Cursor'Read use Read;
299 No_Element : constant Cursor := Cursor'(null, null);
302 (Stream : not null access Root_Stream_Type'Class;
305 for Set'Write use Write;
308 (Stream : not null access Root_Stream_Type'Class;
309 Container : out Set);
311 for Set'Read use Read;
313 Empty_Set : constant Set :=
314 (Controlled with Tree => (First => null,
321 end Ada.Containers.Indefinite_Ordered_Sets;