Ada Programming/Libraries/Ada.Containers.Ordered Sets

Computing » Computer Science » Computer Programming » Ada Programming

---

This language feature is only available from Ada 2005 on.

Ada.Containers.Ordered_Sets is a unit of the Predefined Language Environment since Ada 2005.

Specification

--                     Standard Ada library specification
--   Copyright (c) 2003-2018 Maxim Reznik <reznikmm@gmail.com>
--   Copyright (c) 2004-2016 AXE Consultants
--   Copyright (c) 2004, 2005, 2006 Ada-Europe
--   Copyright (c) 2000 The MITRE Corporation, Inc.
--   Copyright (c) 1992, 1993, 1994, 1995 Intermetrics, Inc.
--   SPDX-License-Identifier: BSD-3-Clause and LicenseRef-AdaReferenceManual
-- -------------------------------------------------------------------------

generic
   type Element_Type is private;

   with function "<" (Left  : in Element_Type;
                      Right : in Element_Type)
          return Boolean is <>;

   with function "=" (Left  : in Element_Type;
                      Right : in Element_Type)
          return Boolean is <>;

package Ada.Containers.Ordered_Sets is

   pragma Preelaborate (Ordered_Sets);

   function Equivalent_Elements (Left  : in Element_Type;
                                 Right : in Element_Type)
     return Boolean;

   type Set is tagged private;
   pragma Preelaborable_Initialization (Set);

   type Cursor is private;
   pragma Preelaborable_Initialization (Cursor);

   Empty_Set : constant Set;

   No_Element : constant Cursor;

   function "=" (Left  : in Set;
                 Right : in Set)
     return Boolean;

   function Equivalent_Sets (Left  : in Set;
                             Right : in Set)
     return Boolean;

   function To_Set (New_Item : in Element_Type) return Set;

   function Length (Container : in Set) return Count_Type;

   function Is_Empty (Container : in Set) return Boolean;

   procedure Clear (Container : in out Set);

   function Element (Position : in Cursor) return Element_Type;

   procedure Replace_Element (Container : in out Set;
                              Position  : in     Cursor;
                              New_Item  : in     Element_Type);

   procedure Query_Element
    (Position : in Cursor;
     Process  : not null access procedure (Element : in Element_Type));

   procedure Move (Target : in out Set;
                   Source : in out Set);

   procedure Insert (Container : in out Set;
                     New_Item  : in     Element_Type;
                     Position  :    out Cursor;
                     Inserted  :    out Boolean);

   procedure Insert (Container : in out Set;
                     New_Item  : in     Element_Type);

   procedure Include (Container : in out Set;
                      New_Item  : in     Element_Type);

   procedure Replace (Container : in out Set;
                      New_Item  : in     Element_Type);

   procedure Exclude (Container : in out Set;
                      Item      : in     Element_Type);

   procedure Delete (Container : in out Set;
                     Item      : in     Element_Type);

   procedure Delete (Container : in out Set;
                     Position  : in out Cursor);

   procedure Delete_First (Container : in out Set);

   procedure Delete_Last (Container : in out Set);

   procedure Union (Target : in out Set;
                    Source : in     Set);

   function Union (Left  : in Set;
                   Right : in Set)
     return Set;

   function "or" (Left  : in Set;
                  Right : in Set)
     return Set renames Union;

   procedure Intersection (Target : in out Set;
                           Source : in     Set);

   function Intersection (Left  : in Set;
                          Right : in Set)
     return Set;

   function "and" (Left  : in Set;
                   Right : in Set)
     return Set renames Intersection;

   procedure Difference (Target : in out Set;
                         Source : in     Set);

   function Difference (Left  : in Set;
                        Right : in Set)
     return Set;

   function "-" (Left  : in Set;
                 Right : in Set)
     return Set renames Difference;

   procedure Symmetric_Difference (Target : in out Set;
                                   Source : in     Set);

   function Symmetric_Difference (Left  : in Set;
                                  Right : in Set)
     return Set;

   function "xor" (Left  : in Set;
                   Right : in Set)
     return Set renames Symmetric_Difference;

   function Overlap (Left  : in Set;
                     Right : in Set)
     return Boolean;

   function Is_Subset (Subset : in Set;
                       Of_Set : in Set)
     return Boolean;

   function First (Container : in Set) return Cursor;

   function First_Element (Container : in Set) return Element_Type;

   function Last (Container : in Set) return Cursor;

   function Last_Element (Container : in Set) return Element_Type;

   function Next (Position : in Cursor) return Cursor;

   procedure Next (Position : in out Cursor);

   function Previous (Position : in Cursor) return Cursor;

   procedure Previous (Position : in out Cursor);

   function Find (Container : in Set;
                  Item      : in Element_Type)
     return Cursor;

   function Floor (Container : in Set;
                   Item      : in Element_Type)
     return Cursor;

   function Ceiling (Container : in Set;
                     Item      : in Element_Type)
     return Cursor;

   function Contains (Container : in Set;
                      Item      : in Element_Type)
     return Boolean;

   function Has_Element (Position : in Cursor) return Boolean;

   function "<" (Left  : in Cursor;
                 Right : in Cursor)
     return Boolean;

   function ">" (Left  : in Cursor;
                 Right : in Cursor)
     return Boolean;

   function "<" (Left  : in Cursor;
                 Right : in Element_Type)
     return Boolean;

   function ">" (Left  : in Cursor;
                 Right : in Element_Type)
     return Boolean;

   function "<" (Left  : in Element_Type;
                 Right : in Cursor)
     return Boolean;

   function ">" (Left  : in Element_Type;
                 Right : in Cursor)
     return Boolean;

   procedure Iterate
    (Container : in Set;
     Process   : not null access procedure (Position : in Cursor));

   procedure Reverse_Iterate
    (Container : in Set;
     Process   : not null access procedure (Position : in Cursor));

   generic
      type Key_Type (<>) is private;

      with function Key (Element : in Element_Type) return Key_Type;

      with function "<" (Left  : in Key_Type;
                         Right : in Key_Type)
             return Boolean is <>;

   package Generic_Keys is

      function Equivalent_Keys (Left  : in Key_Type;
                                Right : in Key_Type)
        return Boolean;

      function Key (Position : in Cursor) return Key_Type;

      function Element (Container : in Set;
                        Key       : in Key_Type)
        return Element_Type;

      procedure Replace (Container : in out Set;
                         Key       : in     Key_Type;
                         New_Item  : in     Element_Type);

      procedure Exclude (Container : in out Set;
                         Key       : in     Key_Type);

      procedure Delete (Container : in out Set;
                        Key       : in     Key_Type);

      function Find (Container : in Set;
                     Key       : in Key_Type)
        return Cursor;

      function Floor (Container : in Set;
                      Key       : in Key_Type)
        return Cursor;

      function Ceiling (Container : in Set;
                        Key       : in Key_Type)
        return Cursor;

      function Contains (Container : in Set;
                         Key       : in Key_Type)
        return Boolean;

      procedure Update_Element_Preserving_Key
       (Container : in out Set;
        Position  : in     Cursor;
        Process   : not null access procedure (Element : in out Element_Type));

   end Generic_Keys;

private

   type Set is tagged null record;

   Empty_Set : constant Set := (null record);

   type Cursor is null record;

   No_Element : constant Cursor := (null record);

end Ada.Containers.Ordered_Sets;

See also

Wikibook

• Ada Programming/Libraries/Ada

External examples

• Search for examples of Ada.Containers.Ordered_Sets in: Rosetta Code, GitHub (gists), any Alire crate or this Wikibook.
• Search for posts related to Ada.Containers.Ordered_Sets in: Stack Overflow, comp.lang.ada or any Ada related page.

Ada Reference Manual

Ada 2005

• A.18.9: The Package Containers.Ordered_Sets ^[Annotated]

Ada 2012

• A.18.9: The Generic Package Containers.Ordered_Sets ^[Annotated]

Open-Source Implementations

FSF GNAT

• Specification: a-coorse.ads
• Body: a-coorse.adb

drake

• Specification: containers/a-coorse.ads
• Body: containers/a-coorse.adb