1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . B O U N D E D _ O R D E R E D _ S E T S --
9 -- Copyright (C) 2004-2012, 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 3, 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. --
22 -- As a special exception under Section 7 of GPL version 3, you are granted --
23 -- additional permissions described in the GCC Runtime Library Exception, --
24 -- version 3.1, as published by the Free Software Foundation. --
26 -- You should have received a copy of the GNU General Public License and --
27 -- a copy of the GCC Runtime Library Exception along with this program; --
28 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
29 -- <http://www.gnu.org/licenses/>. --
31 -- This unit was originally developed by Matthew J Heaney. --
32 ------------------------------------------------------------------------------
34 with Ada.Iterator_Interfaces;
36 private with Ada.Containers.Red_Black_Trees;
37 private with Ada.Streams;
40 type Element_Type is private;
42 with function "<" (Left, Right : Element_Type) return Boolean is <>;
43 with function "=" (Left, Right : Element_Type) return Boolean is <>;
45 package Ada.Containers.Bounded_Ordered_Sets is
49 function Equivalent_Elements (Left, Right : Element_Type) return Boolean;
51 type Set (Capacity : Count_Type) is tagged private
52 with Constant_Indexing => Constant_Reference,
53 Default_Iterator => Iterate,
54 Iterator_Element => Element_Type;
56 pragma Preelaborable_Initialization (Set);
58 type Cursor is private;
59 pragma Preelaborable_Initialization (Cursor);
61 Empty_Set : constant Set;
63 No_Element : constant Cursor;
65 function Has_Element (Position : Cursor) return Boolean;
67 package Set_Iterator_Interfaces is new
68 Ada.Iterator_Interfaces (Cursor, Has_Element);
70 function "=" (Left, Right : Set) return Boolean;
72 function Equivalent_Sets (Left, Right : Set) return Boolean;
74 function To_Set (New_Item : Element_Type) return Set;
76 function Length (Container : Set) return Count_Type;
78 function Is_Empty (Container : Set) return Boolean;
80 procedure Clear (Container : in out Set);
82 function Element (Position : Cursor) return Element_Type;
84 procedure Replace_Element
85 (Container : in out Set;
87 New_Item : Element_Type);
89 procedure Query_Element
91 Process : not null access procedure (Element : Element_Type));
93 type Constant_Reference_Type
94 (Element : not null access constant Element_Type) is
97 Implicit_Dereference => Element;
99 function Constant_Reference
100 (Container : aliased Set;
101 Position : Cursor) return Constant_Reference_Type;
103 procedure Assign (Target : in out Set; Source : Set);
105 function Copy (Source : Set; Capacity : Count_Type := 0) return Set;
107 procedure Move (Target : in out Set; Source : in out Set);
110 (Container : in out Set;
111 New_Item : Element_Type;
112 Position : out Cursor;
113 Inserted : out Boolean);
116 (Container : in out Set;
117 New_Item : Element_Type);
120 (Container : in out Set;
121 New_Item : Element_Type);
124 (Container : in out Set;
125 New_Item : Element_Type);
128 (Container : in out Set;
129 Item : Element_Type);
132 (Container : in out Set;
133 Item : Element_Type);
136 (Container : in out Set;
137 Position : in out Cursor);
139 procedure Delete_First (Container : in out Set);
141 procedure Delete_Last (Container : in out Set);
143 procedure Union (Target : in out Set; Source : Set);
145 function Union (Left, Right : Set) return Set;
147 function "or" (Left, Right : Set) return Set renames Union;
149 procedure Intersection (Target : in out Set; Source : Set);
151 function Intersection (Left, Right : Set) return Set;
153 function "and" (Left, Right : Set) return Set renames Intersection;
155 procedure Difference (Target : in out Set; Source : Set);
157 function Difference (Left, Right : Set) return Set;
159 function "-" (Left, Right : Set) return Set renames Difference;
161 procedure Symmetric_Difference (Target : in out Set; Source : Set);
163 function Symmetric_Difference (Left, Right : Set) return Set;
165 function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
167 function Overlap (Left, Right : Set) return Boolean;
169 function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
171 function First (Container : Set) return Cursor;
173 function First_Element (Container : Set) return Element_Type;
175 function Last (Container : Set) return Cursor;
177 function Last_Element (Container : Set) return Element_Type;
179 function Next (Position : Cursor) return Cursor;
181 procedure Next (Position : in out Cursor);
183 function Previous (Position : Cursor) return Cursor;
185 procedure Previous (Position : in out Cursor);
187 function Find (Container : Set; Item : Element_Type) return Cursor;
189 function Floor (Container : Set; Item : Element_Type) return Cursor;
191 function Ceiling (Container : Set; Item : Element_Type) return Cursor;
193 function Contains (Container : Set; Item : Element_Type) return Boolean;
195 function "<" (Left, Right : Cursor) return Boolean;
197 function ">" (Left, Right : Cursor) return Boolean;
199 function "<" (Left : Cursor; Right : Element_Type) return Boolean;
201 function ">" (Left : Cursor; Right : Element_Type) return Boolean;
203 function "<" (Left : Element_Type; Right : Cursor) return Boolean;
205 function ">" (Left : Element_Type; Right : Cursor) return Boolean;
209 Process : not null access procedure (Position : Cursor));
211 procedure Reverse_Iterate
213 Process : not null access procedure (Position : Cursor));
217 return Set_Iterator_Interfaces.Reversible_Iterator'class;
222 return Set_Iterator_Interfaces.Reversible_Iterator'class;
225 type Key_Type (<>) is private;
227 with function Key (Element : Element_Type) return Key_Type;
229 with function "<" (Left, Right : Key_Type) return Boolean is <>;
231 package Generic_Keys is
233 function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
235 function Key (Position : Cursor) return Key_Type;
237 function Element (Container : Set; Key : Key_Type) return Element_Type;
240 (Container : in out Set;
242 New_Item : Element_Type);
244 procedure Exclude (Container : in out Set; Key : Key_Type);
246 procedure Delete (Container : in out Set; Key : Key_Type);
248 function Find (Container : Set; Key : Key_Type) return Cursor;
250 function Floor (Container : Set; Key : Key_Type) return Cursor;
252 function Ceiling (Container : Set; Key : Key_Type) return Cursor;
254 function Contains (Container : Set; Key : Key_Type) return Boolean;
256 procedure Update_Element_Preserving_Key
257 (Container : in out Set;
259 Process : not null access
260 procedure (Element : in out Element_Type));
262 type Reference_Type (Element : not null access Element_Type) is private
264 Implicit_Dereference => Element;
266 function Reference_Preserving_Key
267 (Container : aliased in out Set;
268 Position : Cursor) return Reference_Type;
270 function Constant_Reference
271 (Container : aliased Set;
272 Key : Key_Type) return Constant_Reference_Type;
274 function Reference_Preserving_Key
275 (Container : aliased in out Set;
276 Key : Key_Type) return Reference_Type;
280 (Element : not null access Element_Type) is null record;
285 (Stream : not null access Root_Stream_Type'Class;
286 Item : out Reference_Type);
288 for Reference_Type'Read use Read;
291 (Stream : not null access Root_Stream_Type'Class;
292 Item : Reference_Type);
294 for Reference_Type'Write use Write;
300 pragma Inline (Next);
301 pragma Inline (Previous);
303 type Node_Type is record
307 Color : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
308 Element : aliased Element_Type;
311 package Tree_Types is
312 new Red_Black_Trees.Generic_Bounded_Tree_Types (Node_Type);
314 type Set (Capacity : Count_Type) is
315 new Tree_Types.Tree_Type (Capacity) with null record;
321 (Stream : not null access Root_Stream_Type'Class;
324 for Set'Write use Write;
327 (Stream : not null access Root_Stream_Type'Class;
328 Container : out Set);
330 for Set'Read use Read;
332 type Set_Access is access all Set;
333 for Set_Access'Storage_Size use 0;
335 -- Note: If a Cursor object has no explicit initialization expression,
336 -- it must default initialize to the same value as constant No_Element.
337 -- The Node component of type Cursor has scalar type Count_Type, so it
338 -- requires an explicit initialization expression of its own declaration,
339 -- in order for objects of record type Cursor to properly initialize.
341 type Cursor is record
342 Container : Set_Access;
343 Node : Count_Type := 0;
347 (Stream : not null access Root_Stream_Type'Class;
350 for Cursor'Write use Write;
353 (Stream : not null access Root_Stream_Type'Class;
356 for Cursor'Read use Read;
358 type Constant_Reference_Type
359 (Element : not null access constant Element_Type) is null record;
362 (Stream : not null access Root_Stream_Type'Class;
363 Item : out Constant_Reference_Type);
365 for Constant_Reference_Type'Read use Read;
368 (Stream : not null access Root_Stream_Type'Class;
369 Item : Constant_Reference_Type);
371 for Constant_Reference_Type'Write use Write;
373 Empty_Set : constant Set := Set'(Tree_Type with Capacity => 0);
375 No_Element : constant Cursor := Cursor'(null, 0);
377 end Ada.Containers.Bounded_Ordered_Sets;