gcc/ada/a-cohase.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT LIBRARY COMPONENTS                          --
   4 --                                                                          --
   5 --           A D A . C O N T A I N E R S . H A S H E D _ 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.Hash_Tables;
  37 with Ada.Streams;
  38 with Ada.Finalization;
  39
  40 generic
  41    type Element_Type is private;
  42
  43    with function Hash (Element : Element_Type) return Hash_Type;
  44
  45    with function Equivalent_Elements (Left, Right : Element_Type)
  46                                      return Boolean;
  47
  48    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  49
  50 package Ada.Containers.Hashed_Sets is
  51    pragma Preelaborate;
  52
  53    type Set is tagged private;
  54    pragma Preelaborable_Initialization (Set);
  55
  56    type Cursor is private;
  57    pragma Preelaborable_Initialization (Cursor);
  58
  59    Empty_Set : constant Set;
  60
  61    No_Element : constant Cursor;
  62
  63    function "=" (Left, Right : Set) return Boolean;
  64
  65    function Equivalent_Sets (Left, Right : Set) return Boolean;
  66
  67    function To_Set (New_Item : Element_Type) return Set;
  68
  69    function Capacity (Container : Set) return Count_Type;
  70
  71    procedure Reserve_Capacity
  72      (Container : in out Set;
  73       Capacity  : Count_Type);
  74
  75    function Length (Container : Set) return Count_Type;
  76
  77    function Is_Empty (Container : Set) return Boolean;
  78
  79    procedure Clear (Container : in out Set);
  80
  81    function Element (Position : Cursor) return Element_Type;
  82
  83    procedure Replace_Element
  84      (Container : in out Set;
  85       Position  : Cursor;
  86       New_Item  : Element_Type);
  87
  88    procedure Query_Element
  89      (Position : Cursor;
  90       Process  : not null access procedure (Element : Element_Type));
  91
  92    procedure Move (Target : in out Set; Source : in out Set);
  93
  94    procedure Insert
  95      (Container : in out Set;
  96       New_Item  : Element_Type;
  97       Position  : out Cursor;
  98       Inserted  : out Boolean);
  99
 100    procedure Insert  (Container : in out Set; New_Item : Element_Type);
 101
 102    procedure Include (Container : in out Set; New_Item : Element_Type);
 103
 104    procedure Replace (Container : in out Set; New_Item : Element_Type);
 105
 106    procedure Exclude (Container : in out Set; Item     : Element_Type);
 107
 108    procedure Delete  (Container : in out Set; Item     : Element_Type);
 109
 110    procedure Delete (Container : in out Set; Position  : in out Cursor);
 111
 112    procedure Union (Target : in out Set; Source : Set);
 113
 114    function Union (Left, Right : Set) return Set;
 115
 116    function "or" (Left, Right : Set) return Set renames Union;
 117
 118    procedure Intersection (Target : in out Set; Source : Set);
 119
 120    function Intersection (Left, Right : Set) return Set;
 121
 122    function "and" (Left, Right : Set) return Set renames Intersection;
 123
 124    procedure Difference (Target : in out Set; Source : Set);
 125
 126    function Difference (Left, Right : Set) return Set;
 127
 128    function "-" (Left, Right : Set) return Set renames Difference;
 129
 130    procedure Symmetric_Difference (Target : in out Set; Source : Set);
 131
 132    function Symmetric_Difference (Left, Right : Set) return Set;
 133
 134    function "xor" (Left, Right : Set) return Set
 135      renames Symmetric_Difference;
 136
 137    function Overlap (Left, Right : Set) return Boolean;
 138
 139    function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
 140
 141    function First (Container : Set) return Cursor;
 142
 143    function Next (Position : Cursor) return Cursor;
 144
 145    procedure Next (Position : in out Cursor);
 146
 147    function Find
 148      (Container : Set;
 149       Item      : Element_Type) return Cursor;
 150
 151    function Contains (Container : Set; Item : Element_Type) return Boolean;
 152
 153    function Has_Element (Position : Cursor) return Boolean;
 154
 155    function Equivalent_Elements (Left, Right : Cursor) return Boolean;
 156
 157    function Equivalent_Elements
 158      (Left  : Cursor;
 159       Right : Element_Type) return Boolean;
 160
 161    function Equivalent_Elements
 162      (Left  : Element_Type;
 163       Right : Cursor) return Boolean;
 164
 165    procedure Iterate
 166      (Container : Set;
 167       Process   : not null access procedure (Position : Cursor));
 168
 169    generic
 170       type Key_Type (<>) is private;
 171
 172       with function Key (Element : Element_Type) return Key_Type;
 173
 174       with function Hash (Key : Key_Type) return Hash_Type;
 175
 176       with function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
 177
 178    package Generic_Keys is
 179
 180       function Key (Position : Cursor) return Key_Type;
 181
 182       function Element (Container : Set; Key : Key_Type) return Element_Type;
 183
 184       procedure Replace
 185         (Container : in out Set;
 186          Key       : Key_Type;
 187          New_Item  : Element_Type);
 188
 189       procedure Exclude (Container : in out Set; Key : Key_Type);
 190
 191       procedure Delete (Container : in out Set; Key : Key_Type);
 192
 193       function Find (Container : Set; Key : Key_Type) return Cursor;
 194
 195       function Contains (Container : Set; Key : Key_Type) return Boolean;
 196
 197       procedure Update_Element_Preserving_Key
 198         (Container : in out Set;
 199          Position  : Cursor;
 200          Process   : not null access
 201                        procedure (Element : in out Element_Type));
 202
 203    end Generic_Keys;
 204
 205 private
 206    type Node_Type;
 207    type Node_Access is access Node_Type;
 208
 209    type Node_Type is
 210       limited record
 211          Element : Element_Type;
 212          Next    : Node_Access;
 213       end record;
 214
 215    package HT_Types is new Hash_Tables.Generic_Hash_Table_Types
 216      (Node_Type,
 217       Node_Access);
 218
 219    type Set is new Ada.Finalization.Controlled with record
 220       HT : HT_Types.Hash_Table_Type;
 221    end record;
 222
 223    procedure Adjust (Container : in out Set);
 224
 225    procedure Finalize (Container : in out Set);
 226
 227    use HT_Types;
 228    use Ada.Finalization;
 229    use Ada.Streams;
 230
 231    type Set_Access is access all Set;
 232    for Set_Access'Storage_Size use 0;
 233
 234    type Cursor is
 235       record
 236          Container : Set_Access;
 237          Node      : Node_Access;
 238       end record;
 239
 240    procedure Write
 241      (Stream : access Root_Stream_Type'Class;
 242       Item   : Cursor);
 243
 244    for Cursor'Write use Write;
 245
 246    procedure Read
 247      (Stream : access Root_Stream_Type'Class;
 248       Item   : out Cursor);
 249
 250    for Cursor'Read use Read;
 251
 252    No_Element : constant Cursor := (Container => null, Node => null);
 253
 254    procedure Write
 255      (Stream    : access Root_Stream_Type'Class;
 256       Container : Set);
 257
 258    for Set'Write use Write;
 259
 260    procedure Read
 261      (Stream    : access Root_Stream_Type'Class;
 262       Container : out Set);
 263
 264    for Set'Read use Read;
 265
 266    Empty_Set : constant Set := (Controlled with HT => (null, 0, 0, 0));
 267
 268 end Ada.Containers.Hashed_Sets;