gcc/ada/g-hesorg.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUNTIME COMPONENTS                          --
   4 --                                                                          --
   5 --                     G N A T . H E A P _ S O R T _ G                      --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --           Copyright (C) 1995-2000 Ada Core Technologies, Inc.            --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  20 -- MA 02111-1307, USA.                                                      --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT is maintained by Ada Core Technologies Inc (http://www.gnat.com).   --
  30 --                                                                          --
  31 ------------------------------------------------------------------------------
  32
  33 --  Heapsort generic package using formal procedures
  34
  35 --  This package provides a generic heapsort routine that can be used with
  36 --  different types of data. See also GNAT.Heap_Sort_A, a version that works
  37 --  with subprogram parameters, allowing code sharing. The generic version
  38 --  is slightly more efficient but does not allow code sharing. The generic
  39 --  version is also Pure, while the access version can only be Preelaborate.
  40
  41 generic
  42    --  The data to be sorted is assumed to be indexed by integer values from
  43    --  1 to N, where N is the number of items to be sorted. In addition, the
  44    --  index value zero is used for a temporary location used during the sort.
  45
  46    with procedure Move (From : Natural; To : Natural);
  47    --  A procedure that moves the data item with index From to the data item
  48    --  with Index To. An index value of zero is used for moves from and to a
  49    --  single temporary location used by the sort.
  50
  51    with function Lt (Op1, Op2 : Natural) return Boolean;
  52    --  A function that compares two items and returns True if the item with
  53    --  index Op1 is less than the item with Index Op2, and False if the Op1
  54    --  item is greater than or equal to the Op2 item.
  55
  56 package GNAT.Heap_Sort_G is
  57 pragma Pure (Heap_Sort_G);
  58
  59    procedure Sort (N : Natural);
  60    --  This procedures sorts items in the range from 1 to N into ascending
  61    --  order making calls to Lt to do required comparisons, and Move to move
  62    --  items around. Note that, as described above, both Move and Lt use a
  63    --  single temporary location with index value zero. This sort is not
  64    --  stable, i.e. the order of equal elements in the input is not preserved.
  65
  66 end GNAT.Heap_Sort_G;