gcc/ada/a-coormu.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT LIBRARY COMPONENTS                          --
   4 --                                                                          --
   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      --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2004-2006, Free Software Foundation, Inc.         --
  10 --                                                                          --
  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. --
  14 --                                                                          --
  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.                                              --
  25 --                                                                          --
  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.                                      --
  32 --                                                                          --
  33 -- This unit was originally developed by Matthew J Heaney.                  --
  34 ------------------------------------------------------------------------------
  35
  36 with Ada.Containers.Red_Black_Trees;
  37 with Ada.Finalization;
  38 with Ada.Streams;
  39
  40 generic
  41    type Element_Type is private;
  42
  43    with function "<" (Left, Right : Element_Type) return Boolean is <>;
  44    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  45
  46 package Ada.Containers.Ordered_Multisets is
  47    pragma Preelaborate;
  48
  49    function Equivalent_Elements (Left, Right : Element_Type) return Boolean;
  50
  51    type Set is tagged private;
  52    pragma Preelaborable_Initialization (Set);
  53
  54    type Cursor is private;
  55    pragma Preelaborable_Initialization (Cursor);
  56
  57    Empty_Set : constant Set;
  58
  59    No_Element : constant Cursor;
  60
  61    function "=" (Left, Right : Set) return Boolean;
  62
  63    function Equivalent_Sets (Left, Right : Set) return Boolean;
  64
  65    function To_Set (New_Item : Element_Type) return Set;
  66
  67    function Length (Container : Set) return Count_Type;
  68
  69    function Is_Empty (Container : Set) return Boolean;
  70
  71    procedure Clear (Container : in out Set);
  72
  73    function Element (Position : Cursor) return Element_Type;
  74
  75    procedure Replace_Element
  76      (Container : in out Set;
  77       Position  : Cursor;
  78       New_Item  : Element_Type);
  79
  80    procedure Query_Element
  81      (Position : Cursor;
  82       Process  : not null access procedure (Element : Element_Type));
  83
  84    procedure Move (Target : in out Set; Source : in out Set);
  85
  86    procedure Insert
  87      (Container : in out Set;
  88       New_Item  : Element_Type;
  89       Position  : out Cursor);
  90
  91    procedure Insert
  92      (Container : in out Set;
  93       New_Item  : Element_Type);
  94
  95 --  TODO: include Replace too???
  96 --
  97 --     procedure Replace
  98 --       (Container : in out Set;
  99 --        New_Item  : Element_Type);
 100
 101    procedure Exclude
 102      (Container : in out Set;
 103       Item      : Element_Type);
 104
 105    procedure Delete
 106      (Container : in out Set;
 107       Item      : Element_Type);
 108
 109    procedure Delete
 110      (Container : in out Set;
 111       Position  : in out Cursor);
 112
 113    procedure Delete_First (Container : in out Set);
 114
 115    procedure Delete_Last (Container : in out Set);
 116
 117    procedure Union (Target : in out Set; Source : Set);
 118
 119    function Union (Left, Right : Set) return Set;
 120
 121    function "or" (Left, Right : Set) return Set renames Union;
 122
 123    procedure Intersection (Target : in out Set; Source : Set);
 124
 125    function Intersection (Left, Right : Set) return Set;
 126
 127    function "and" (Left, Right : Set) return Set renames Intersection;
 128
 129    procedure Difference (Target : in out Set; Source : Set);
 130
 131    function Difference (Left, Right : Set) return Set;
 132
 133    function "-" (Left, Right : Set) return Set renames Difference;
 134
 135    procedure Symmetric_Difference (Target : in out Set; Source : Set);
 136
 137    function Symmetric_Difference (Left, Right : Set) return Set;
 138
 139    function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
 140
 141    function Overlap (Left, Right : Set) return Boolean;
 142
 143    function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
 144
 145    function First (Container : Set) return Cursor;
 146
 147    function First_Element (Container : Set) return Element_Type;
 148
 149    function Last (Container : Set) return Cursor;
 150
 151    function Last_Element (Container : Set) return Element_Type;
 152
 153    function Next (Position : Cursor) return Cursor;
 154
 155    procedure Next (Position : in out Cursor);
 156
 157    function Previous (Position : Cursor) return Cursor;
 158
 159    procedure Previous (Position : in out Cursor);
 160
 161    function Find (Container : Set; Item : Element_Type) return Cursor;
 162
 163    function Floor (Container : Set; Item : Element_Type) return Cursor;
 164
 165    function Ceiling (Container : Set; Item : Element_Type) return Cursor;
 166
 167    function Contains (Container : Set; Item : Element_Type) return Boolean;
 168
 169    function Has_Element (Position : Cursor) return Boolean;
 170
 171    function "<" (Left, Right : Cursor) return Boolean;
 172
 173    function ">" (Left, Right : Cursor) return Boolean;
 174
 175    function "<" (Left : Cursor; Right : Element_Type) return Boolean;
 176
 177    function ">" (Left : Cursor; Right : Element_Type) return Boolean;
 178
 179    function "<" (Left : Element_Type; Right : Cursor) return Boolean;
 180
 181    function ">" (Left : Element_Type; Right : Cursor) return Boolean;
 182
 183    procedure Iterate
 184      (Container : Set;
 185       Process   : not null access procedure (Position : Cursor));
 186
 187    procedure Reverse_Iterate
 188      (Container : Set;
 189       Process   : not null access procedure (Position : Cursor));
 190
 191    procedure Iterate
 192      (Container : Set;
 193       Item      : Element_Type;
 194       Process   : not null access procedure (Position : Cursor));
 195
 196    procedure Reverse_Iterate
 197      (Container : Set;
 198       Item      : Element_Type;
 199       Process   : not null access procedure (Position : Cursor));
 200
 201    generic
 202       type Key_Type (<>) is private;
 203
 204       with function Key (Element : Element_Type) return Key_Type;
 205
 206       with function "<" (Left, Right : Key_Type) return Boolean is <>;
 207
 208    package Generic_Keys is
 209
 210       function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
 211
 212       function Key (Position : Cursor) return Key_Type;
 213
 214       function Element (Container : Set; Key : Key_Type) return Element_Type;
 215
 216       procedure Exclude (Container : in out Set; Key : Key_Type);
 217
 218       procedure Delete (Container : in out Set; Key : Key_Type);
 219
 220       function Find (Container : Set; Key : Key_Type) return Cursor;
 221
 222       function Floor (Container : Set; Key : Key_Type) return Cursor;
 223
 224       function Ceiling (Container : Set; Key : Key_Type) return Cursor;
 225
 226       function Contains (Container : Set; Key : Key_Type) return Boolean;
 227
 228       procedure Update_Element
 229         (Container : in out Set;
 230          Position  : Cursor;
 231          Process   : not null access
 232                        procedure (Element : in out Element_Type));
 233
 234       procedure Iterate
 235         (Container : Set;
 236          Key       : Key_Type;
 237          Process   : not null access procedure (Position : Cursor));
 238
 239       procedure Reverse_Iterate
 240         (Container : Set;
 241          Key       : Key_Type;
 242          Process   : not null access procedure (Position : Cursor));
 243
 244    end Generic_Keys;
 245
 246 private
 247
 248    type Node_Type;
 249    type Node_Access is access Node_Type;
 250
 251    type Node_Type is limited record
 252       Parent  : Node_Access;
 253       Left    : Node_Access;
 254       Right   : Node_Access;
 255       Color   : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
 256       Element : Element_Type;
 257    end record;
 258
 259    package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
 260      (Node_Type,
 261       Node_Access);
 262
 263    type Set is new Ada.Finalization.Controlled with record
 264       Tree : Tree_Types.Tree_Type;
 265    end record;
 266
 267    procedure Adjust (Container : in out Set);
 268
 269    procedure Finalize (Container : in out Set) renames Clear;
 270
 271    use Red_Black_Trees;
 272    use Tree_Types;
 273    use Ada.Finalization;
 274    use Ada.Streams;
 275
 276    type Set_Access is access all Set;
 277    for Set_Access'Storage_Size use 0;
 278
 279    type Cursor is record
 280       Container : Set_Access;
 281       Node      : Node_Access;
 282    end record;
 283
 284    procedure Write
 285      (Stream : access Root_Stream_Type'Class;
 286       Item   : Cursor);
 287
 288    for Cursor'Write use Write;
 289
 290    procedure Read
 291      (Stream : access Root_Stream_Type'Class;
 292       Item   : out Cursor);
 293
 294    for Cursor'Read use Read;
 295
 296    No_Element : constant Cursor := Cursor'(null, null);
 297
 298    procedure Write
 299      (Stream    : access Root_Stream_Type'Class;
 300       Container : Set);
 301
 302    for Set'Write use Write;
 303
 304    procedure Read
 305      (Stream    : access Root_Stream_Type'Class;
 306       Container : out Set);
 307
 308    for Set'Read use Read;
 309
 310    Empty_Set : constant Set :=
 311                  (Controlled with Tree => (First  => null,
 312                                            Last   => null,
 313                                            Root   => null,
 314                                            Length => 0,
 315                                            Busy   => 0,
 316                                            Lock   => 0));
 317
 318 end Ada.Containers.Ordered_Multisets;