------------------------------------------------------------------------------
------------------------------------------------------------------------------
-- Cheddar is a GNU GPL real-time scheduling analysis tool.
-- This program provides services to automatically check schedulability and
-- other performance criteria of real-time architecture models.
--
-- Copyright (C) 2002-2020, Frank Singhoff, Alain Plantec, Jerome Legrand,
--                          Hai Nam Tran, Stephane Rubini
--
-- The Cheddar project was started in 2002 by
-- Frank Singhoff, Lab-STICC UMR 6285, Université de Bretagne Occidentale
--
-- Cheddar has been published in the "Agence de Protection des Programmes/France" in 2008.
-- Since 2008, Ellidiss technologies also contributes to the development of
-- Cheddar and provides industrial support.
--
-- The full list of contributors and sponsors can be found in AUTHORS.txt and SPONSORS.txt
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 2 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program; if not, write to the Free Software
-- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
--
--
-- Contact : cheddar@listes.univ-brest.fr
--
------------------------------------------------------------------------------
-- Last update :
--    $Rev$
--    $Date$
--    $Author: singhoff $
------------------------------------------------------------------------------
------------------------------------------------------------------------------

with Ada.Text_IO;           use Ada.Text_IO;
with Ada.Unchecked_Deallocation;
with Ada.Strings.Unbounded; use Ada.Strings.Unbounded;

package integer_arrays is

   ------------------------------------------------------
   -- This package implements an array which is
   -- - Not bounded
   -- - Extendable
   -- - Can perform some methods such as sort, union, intersection.
   ------------------------------------------------------

   type integer_arr is array (Integer range <>) of Integer;
   type integer_arr_ptr is access integer_arr;

   procedure free is new Ada.Unchecked_Deallocation
     (Object => integer_arr,
      Name   => integer_arr_ptr);

   type integer_array is record
      size     : Integer := 0;
      elements : integer_arr_ptr;
   end record;

   procedure free (arr : in out integer_array);

   procedure initialize (arr : in out integer_array);

   procedure initialize
     (arr       : in out integer_array;
      elements  : in     String;
      separator : in     String);

-----------------------------------------------------------------------------

   procedure print (arr : in integer_array);

   procedure put (arr : in integer_array);

   function xml_string (obj : in integer_array) return Unbounded_String;

   procedure add (arr : in out integer_array; element : in Integer);

   procedure add
     (arr               : in out integer_array;
      element_identical : in     Boolean;
      element           : in     Integer);
   -- Add an element to the Array

   procedure remove (arr : in out integer_array; index : Integer);
   -- Remove an element at index index

   procedure remove_by_value (arr : in out integer_array; value : Integer);
   -- Remove an element which has value value

   function remove_by_value
     (arr   : in out integer_array;
      value :        Integer) return Boolean;
-- Remove an element which has value value, return true if a element is removed

   procedure union (arr_a : in out integer_array; arr_b : in integer_array);
   -- Union the arr_b with the arr_a
   -- The arr_a is the result of the union.

   procedure intersect
     (arr_a : in     integer_array;
      arr_b : in     integer_array;
      arr_c :    out integer_array;
      n     :    out Integer);
   --Intersect arr_a with arr_b
   --Result in arr_c
   --n is the number of intersection.

   procedure intersect
     (arr_a : in     integer_array;
      arr_b : in     integer_array;
      n     :    out Integer);
   --Intersect arr_a with arr_b
   --n is the number of intersection.

   procedure sort_desc (arr_a : in out integer_array);

   procedure sort_asc (arr_a : in out integer_array);

   function multiset_intersection
     (arr_a : in integer_array;
      arr_b : in integer_array) return integer_array;
end integer_arrays;