1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . O R D E R E D _ M U L T I S E T S --
9 -- Copyright (C) 2004-2005 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.Red_Black_Trees;
37 with Ada.Finalization;
41 type Element_Type is private;
43 with function "<" (Left, Right : Element_Type) return Boolean is <>;
44 with function "=" (Left, Right : Element_Type) return Boolean is <>;
46 package Ada.Containers.Ordered_Multisets is
47 pragma Preelaborate (Ordered_Multisets);
49 type Set is tagged private;
51 type Cursor is private;
53 Empty_Set : constant Set;
55 No_Element : constant Cursor;
57 function "=" (Left, Right : Set) return Boolean;
59 function Equivalent_Sets (Left, Right : Set) return Boolean;
61 function Length (Container : Set) return Count_Type;
63 function Is_Empty (Container : Set) return Boolean;
65 procedure Clear (Container : in out Set);
67 function Element (Position : Cursor) return Element_Type;
69 procedure Query_Element
71 Process : not null access procedure (Element : Element_Type));
73 procedure Replace_Element
83 (Container : in out Set;
84 New_Item : Element_Type;
85 Position : out Cursor);
88 (Container : in out Set;
89 New_Item : Element_Type);
92 (Container : in out Set;
96 (Container : in out Set;
97 Position : in out Cursor);
99 procedure Delete_First (Container : in out Set);
101 procedure Delete_Last (Container : in out Set);
104 (Container : in out Set;
105 Item : Element_Type);
107 procedure Union (Target : in out Set; Source : Set);
109 function Union (Left, Right : Set) return Set;
111 function "or" (Left, Right : Set) return Set renames Union;
113 procedure Intersection (Target : in out Set; Source : Set);
115 function Intersection (Left, Right : Set) return Set;
117 function "and" (Left, Right : Set) return Set renames Intersection;
119 procedure Difference (Target : in out Set; Source : Set);
121 function Difference (Left, Right : Set) return Set;
123 function "-" (Left, Right : Set) return Set renames Difference;
125 procedure Symmetric_Difference (Target : in out Set; Source : Set);
127 function Symmetric_Difference (Left, Right : Set) return Set;
129 function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
131 function Overlap (Left, Right : Set) return Boolean;
133 function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
135 function Contains (Container : Set; Item : Element_Type) return Boolean;
137 function Find (Container : Set; Item : Element_Type) return Cursor;
139 function Floor (Container : Set; Item : Element_Type) return Cursor;
141 function Ceiling (Container : Set; Item : Element_Type) return Cursor;
143 function First (Container : Set) return Cursor;
145 function First_Element (Container : Set) return Element_Type;
147 function Last (Container : Set) return Cursor;
149 function Last_Element (Container : Set) return Element_Type;
151 function Next (Position : Cursor) return Cursor;
153 procedure Next (Position : in out Cursor);
155 function Previous (Position : Cursor) return Cursor;
157 procedure Previous (Position : in out Cursor);
159 function Has_Element (Position : Cursor) return Boolean;
161 function "<" (Left, Right : Cursor) return Boolean;
163 function ">" (Left, Right : Cursor) return Boolean;
165 function "<" (Left : Cursor; Right : Element_Type) return Boolean;
167 function ">" (Left : Cursor; Right : Element_Type) return Boolean;
169 function "<" (Left : Element_Type; Right : Cursor) return Boolean;
171 function ">" (Left : Element_Type; Right : Cursor) return Boolean;
175 Process : not null access procedure (Position : Cursor));
177 procedure Reverse_Iterate
179 Process : not null access procedure (Position : Cursor));
184 Process : not null access procedure (Position : Cursor));
186 procedure Reverse_Iterate
189 Process : not null access procedure (Position : Cursor));
192 type Key_Type (<>) is limited private;
194 with function Key (Element : Element_Type) return Key_Type;
196 with function "<" (Left : Key_Type; Right : Element_Type)
197 return Boolean is <>;
199 with function ">" (Left : Key_Type; Right : Element_Type)
200 return Boolean is <>;
202 package Generic_Keys is
204 function Contains (Container : Set; Key : Key_Type) return Boolean;
206 function Find (Container : Set; Key : Key_Type) return Cursor;
208 function Floor (Container : Set; Key : Key_Type) return Cursor;
210 function Ceiling (Container : Set; Key : Key_Type) return Cursor;
212 function Key (Position : Cursor) return Key_Type;
214 function Element (Container : Set; Key : Key_Type) return Element_Type;
216 procedure Delete (Container : in out Set; Key : Key_Type);
218 procedure Exclude (Container : in out Set; Key : Key_Type);
220 function "<" (Left : Cursor; Right : Key_Type) return Boolean;
222 function ">" (Left : Cursor; Right : Key_Type) return Boolean;
224 function "<" (Left : Key_Type; Right : Cursor) return Boolean;
226 function ">" (Left : Key_Type; Right : Cursor) return Boolean;
228 procedure Update_Element_Preserving_Key
229 (Container : in out Set;
231 Process : not null access
232 procedure (Element : in out Element_Type));
237 Process : not null access procedure (Position : Cursor));
239 procedure Reverse_Iterate
242 Process : not null access procedure (Position : Cursor));
249 type Node_Access is access Node_Type;
251 type Node_Type is limited record
252 Parent : Node_Access;
255 Color : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
256 Element : Element_Type;
259 package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
263 type Set is new Ada.Finalization.Controlled with record
264 Tree : Tree_Types.Tree_Type;
267 procedure Adjust (Container : in out Set);
269 procedure Finalize (Container : in out Set) renames Clear;
273 use Ada.Finalization;
275 type Set_Access is access all Set;
276 for Set_Access'Storage_Size use 0;
278 type Cursor is record
279 Container : Set_Access;
283 No_Element : constant Cursor := Cursor'(null, null);
288 (Stream : access Root_Stream_Type'Class;
291 for Set'Write use Write;
294 (Stream : access Root_Stream_Type'Class;
295 Container : out Set);
297 for Set'Read use Read;
299 Empty_Set : constant Set :=
300 (Controlled with Tree => (First => null,
307 end Ada.Containers.Ordered_Multisets;