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 _ M U L T I S E T S --
10 -- Copyright (C) 2004-2006, 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_Multisets is
50 function Equivalent_Elements (Left, Right : Element_Type) return Boolean;
52 type Set is tagged private;
53 pragma Preelaborable_Initialization (Set);
55 type Cursor is private;
56 pragma Preelaborable_Initialization (Cursor);
58 Empty_Set : constant Set;
60 No_Element : constant Cursor;
62 function "=" (Left, Right : Set) return Boolean;
64 function Equivalent_Sets (Left, Right : Set) return Boolean;
66 function To_Set (New_Item : Element_Type) return Set;
68 function Length (Container : Set) return Count_Type;
70 function Is_Empty (Container : Set) return Boolean;
72 procedure Clear (Container : in out Set);
74 function Element (Position : Cursor) return Element_Type;
76 procedure Replace_Element
77 (Container : in out Set;
79 New_Item : Element_Type);
81 procedure Query_Element
83 Process : not null access procedure (Element : Element_Type));
85 procedure Move (Target : in out Set; Source : in out Set);
88 (Container : in out Set;
89 New_Item : Element_Type;
90 Position : out Cursor);
92 procedure Insert (Container : in out Set; New_Item : Element_Type);
94 -- TODO: include Replace too???
97 -- (Container : in out Set;
98 -- New_Item : Element_Type);
100 procedure Exclude (Container : in out Set; Item : Element_Type);
102 procedure Delete (Container : in out Set; Item : Element_Type);
104 procedure Delete (Container : in out Set; Position : in out Cursor);
106 procedure Delete_First (Container : in out Set);
108 procedure Delete_Last (Container : in out Set);
110 procedure Union (Target : in out Set; Source : Set);
112 function Union (Left, Right : Set) return Set;
114 function "or" (Left, Right : Set) return Set renames Union;
116 procedure Intersection (Target : in out Set; Source : Set);
118 function Intersection (Left, Right : Set) return Set;
120 function "and" (Left, Right : Set) return Set renames Intersection;
122 procedure Difference (Target : in out Set; Source : Set);
124 function Difference (Left, Right : Set) return Set;
126 function "-" (Left, Right : Set) return Set renames Difference;
128 procedure Symmetric_Difference (Target : in out Set; Source : Set);
130 function Symmetric_Difference (Left, Right : Set) return Set;
132 function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
134 function Overlap (Left, Right : Set) return Boolean;
136 function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
138 function First (Container : Set) return Cursor;
140 function First_Element (Container : Set) return Element_Type;
142 function Last (Container : Set) return Cursor;
144 function Last_Element (Container : Set) return Element_Type;
146 function Next (Position : Cursor) return Cursor;
148 procedure Next (Position : in out Cursor);
150 function Previous (Position : Cursor) return Cursor;
152 procedure Previous (Position : in out Cursor);
154 function Find (Container : Set; Item : Element_Type) return Cursor;
156 function Floor (Container : Set; Item : Element_Type) return Cursor;
158 function Ceiling (Container : Set; Item : Element_Type) return Cursor;
160 function Contains (Container : Set; Item : Element_Type) return Boolean;
162 function Has_Element (Position : Cursor) return Boolean;
164 function "<" (Left, Right : Cursor) return Boolean;
166 function ">" (Left, Right : Cursor) return Boolean;
168 function "<" (Left : Cursor; Right : Element_Type) return Boolean;
170 function ">" (Left : Cursor; Right : Element_Type) return Boolean;
172 function "<" (Left : Element_Type; Right : Cursor) return Boolean;
174 function ">" (Left : Element_Type; Right : Cursor) return Boolean;
178 Process : not null access procedure (Position : Cursor));
180 procedure Reverse_Iterate
182 Process : not null access procedure (Position : Cursor));
187 Process : not null access procedure (Position : Cursor));
189 procedure Reverse_Iterate
192 Process : not null access procedure (Position : Cursor));
195 type Key_Type (<>) is private;
197 with function Key (Element : Element_Type) return Key_Type;
199 with function "<" (Left, Right : Key_Type) return Boolean is <>;
201 package Generic_Keys is
203 function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
205 function Key (Position : Cursor) return Key_Type;
207 function Element (Container : Set; Key : Key_Type) return Element_Type;
209 procedure Exclude (Container : in out Set; Key : Key_Type);
211 procedure Delete (Container : in out Set; Key : Key_Type);
213 function Find (Container : Set; Key : Key_Type) return Cursor;
215 function Floor (Container : Set; Key : Key_Type) return Cursor;
217 function Ceiling (Container : Set; Key : Key_Type) return Cursor;
219 function Contains (Container : Set; Key : Key_Type) return Boolean;
221 procedure Update_Element
222 (Container : in out Set;
224 Process : not null access
225 procedure (Element : in out Element_Type));
230 Process : not null access procedure (Position : Cursor));
232 procedure Reverse_Iterate
235 Process : not null access procedure (Position : Cursor));
242 type Node_Access is access Node_Type;
244 type Element_Access is access Element_Type;
246 type Node_Type is limited record
247 Parent : Node_Access;
250 Color : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
251 Element : Element_Access;
254 package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
258 type Set is new Ada.Finalization.Controlled with record
259 Tree : Tree_Types.Tree_Type;
262 procedure Adjust (Container : in out Set);
264 procedure Finalize (Container : in out Set) renames Clear;
268 use Ada.Finalization;
271 type Set_Access is access all Set;
272 for Set_Access'Storage_Size use 0;
274 type Cursor is record
275 Container : Set_Access;
280 (Stream : not null access Root_Stream_Type'Class;
283 for Cursor'Write use Write;
286 (Stream : not null access Root_Stream_Type'Class;
289 for Cursor'Read use Read;
291 No_Element : constant Cursor := Cursor'(null, null);
294 (Stream : not null access Root_Stream_Type'Class;
297 for Set'Write use Write;
300 (Stream : not null access Root_Stream_Type'Class;
301 Container : out Set);
303 for Set'Read use Read;
305 Empty_Set : constant Set :=
306 (Controlled with Tree => (First => null,
313 end Ada.Containers.Indefinite_Ordered_Multisets;