2006-10-31 Matt Heaney <heaney@adacore.com>

	* a-crbtgo.ads: Commented each subprogram

	* a-crbtgo.adb: Added reference to book from which algorithms were
	adapted.

        * a-crbtgk.ads, a-crbtgk.adb (Generic_Insert_Post): pass flag to
	indicate which child.
	(Generic_Conditional_Insert): changed parameter name from "Success" to
	"Inserted".
	(Generic_Unconditional_Insert_With_Hint): improved algorithm

	* a-coorse.adb (Replace_Element): changed parameter name in call to
	conditional insert operation.

	* a-convec.adb, a-coinve.adb (Insert): removed obsolete comment

	* a-cohama.adb (Iterate): manipulate busy-bit here, instead of in
	Generic_Iteration

	* a-ciorse.adb (Replace_Element): changed parameter name in call to
	conditional insert operation.

	* a-cihama.adb (Iterate): manipulate busy-bit here, instead of in
	Generic_Iteration.

	* a-cidlli.ads, a-cidlli.adb (Splice): Position param is now mode in
	instead of mode inout.

	* a-chtgop.adb (Adjust): modified comments to reflect current AI-302
	draft
	(Generic_Read): preserve existing buckets array if possible
	(Generic_Write): don't send buckets array length anymore

	* a-cdlili.ads, a-cdlili.adb (Splice): Position param is now mode in
	instead of mode inout.

	* a-cihase.adb (Difference): iterate over smaller of Tgt and Src sets
	(Iterate): manipulate busy-bit here, instead of in Generic_Iteration

	* a-cohase.adb (Difference): iterate over smaller of Tgt and Src sets
	(Iterate): manipulate busy-bit here, instead of in Generic_Iteration
	(Replace_Element): local operation is now an instantiation

	* a-chtgke.ads, a-chtgke.adb (Generic_Conditional_Insert): manually
	check current length.
	(Generic_Replace_Element): new operation



git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@118324 138bc75d-0d04-0410-961f-82ee72b054a4

1 files changed, 42 insertions, 5 deletions

diff --git a/gcc/ada/a-crbtgo.ads b/gcc/ada/a-crbtgo.ads
index a213a283010..0415f5be2de 100644
--- a/gcc/ada/a-crbtgo.ads
+++ b/gcc/ada/a-crbtgo.ads
@@ -7,11 +7,7 @@
 --                                                                          --
 --                                 S p e c                                  --
 --                                                                          --
---          Copyright (C) 2004-2005, Free Software Foundation, Inc.         --
---                                                                          --
--- This specification is derived from the Ada Reference Manual for use with --
--- GNAT. The copyright notice above, and the license provisions that follow --
--- apply solely to the  contents of the part following the private keyword. --
+--          Copyright (C) 2004-2006, Free Software Foundation, Inc.         --
 --                                                                          --
 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
 -- terms of the  GNU General Public License as published  by the Free Soft- --
@@ -34,6 +30,9 @@
 -- This unit was originally developed by Matthew J Heaney.                  --
 ------------------------------------------------------------------------------
 
+--  Tree_Type is used to implement the ordered containers. This package
+--  declares the tree operations that do not depend on keys.
+
 with Ada.Streams; use Ada.Streams;
 
 generic
@@ -53,8 +52,10 @@ package Ada.Containers.Red_Black_Trees.Generic_Operations is
    pragma Pure;
 
    function Min (Node : Node_Access) return Node_Access;
+   --  Returns the smallest-valued node of the subtree rooted at Node
 
    function Max (Node : Node_Access) return Node_Access;
+   --  Returns the largest-valued node of the subtree rooted at Node
 
    --  NOTE: The Check_Invariant operation was used during early
    --  development of the red-black tree. Now that the tree type
@@ -64,47 +65,75 @@ package Ada.Containers.Red_Black_Trees.Generic_Operations is
    --  procedure Check_Invariant (Tree : Tree_Type);
 
    function Vet (Tree : Tree_Type; Node : Node_Access) return Boolean;
+   --  Inspects Node to determine (to the extent possible) whether
+   --  the node is valid; used to detect if the node is dangling.
 
    function Next (Node : Node_Access) return Node_Access;
+   --  Returns the smallest node greater than Node
 
    function Previous (Node : Node_Access) return Node_Access;
+   --  Returns the largest node less than Node
 
    generic
       with function Is_Equal (L, R : Node_Access) return Boolean;
    function Generic_Equal (Left, Right : Tree_Type) return Boolean;
+   --  Uses Is_Equal to perform a node-by-node comparison of the
+   --  Left and Right trees; processing stops as soon as the first
+   --  non-equal node is found.
 
    procedure Delete_Node_Sans_Free
      (Tree : in out Tree_Type;
       Node : Node_Access);
+   --  Removes Node from Tree without deallocating the node. If Tree
+   --  is busy then Program_Error is raised.
 
    generic
       with procedure Free (X : in out Node_Access);
    procedure Generic_Delete_Tree (X : in out Node_Access);
+   --  Deallocates the tree rooted at X, calling Free on each node
 
    generic
       with function Copy_Node (Source : Node_Access) return Node_Access;
       with procedure Delete_Tree (X : in out Node_Access);
    function Generic_Copy_Tree (Source_Root : Node_Access) return Node_Access;
+   --  Copies the tree rooted at Source_Root, using Copy_Node to copy each
+   --  node of the source tree. If Copy_Node propagates an exception
+   --  (e.g. Storage_Error), then Delete_Tree is first used to deallocate
+   --  the target tree, and then the exception is propagated.
 
    generic
       with function Copy_Tree (Root : Node_Access) return Node_Access;
    procedure Generic_Adjust (Tree : in out Tree_Type);
+   --  Used to implement controlled Adjust. On input to Generic_Adjust, Tree
+   --  holds a bitwise (shallow) copy of the source tree (as would be the case
+   --  when controlled Adjust is called). On output, Tree holds its own (deep)
+   --  copy of the source tree, which is constructed by calling Copy_Tree.
 
    generic
       with procedure Delete_Tree (X : in out Node_Access);
    procedure Generic_Clear (Tree : in out Tree_Type);
+   --  Clears Tree by deallocating all of its nodes. If Tree is busy then
+   --  Program_Error is raised.
 
    generic
       with procedure Clear (Tree : in out Tree_Type);
    procedure Generic_Move (Target, Source : in out Tree_Type);
+   --  Moves the tree belonging to Source onto Target. If Source is busy then
+   --  Program_Error is raised. Otherwise Target is first cleared (by calling
+   --  Clear, to deallocate its existing tree), then given the Source tree, and
+   --  then finally Source is cleared (by setting its pointers to null).
 
    generic
       with procedure Process (Node : Node_Access) is <>;
    procedure Generic_Iteration (Tree : Tree_Type);
+   --  Calls Process for each node in Tree, in order from smallest-valued
+   --  node to largest-valued node.
 
    generic
       with procedure Process (Node : Node_Access) is <>;
    procedure Generic_Reverse_Iteration (Tree : Tree_Type);
+   --  Calls Process for each node in Tree, in order from largest-valued
+   --  node to smallest-valued node.
 
    generic
       with procedure Write_Node
@@ -113,6 +142,9 @@ package Ada.Containers.Red_Black_Trees.Generic_Operations is
    procedure Generic_Write
      (Stream : access Root_Stream_Type'Class;
       Tree   : Tree_Type);
+   --  Used to implement stream attribute T'Write. Generic_Write
+   --  first writes the number of nodes into Stream, then calls
+   --  Write_Node for each node in Tree.
 
    generic
       with procedure Clear (Tree : in out Tree_Type);
@@ -121,9 +153,14 @@ package Ada.Containers.Red_Black_Trees.Generic_Operations is
    procedure Generic_Read
      (Stream : access Root_Stream_Type'Class;
       Tree   : in out Tree_Type);
+   --  Used to implement stream attribute T'Read. Generic_Read
+   --  first clears Tree. It then reads the number of nodes out of
+   --  Stream, and calls Read_Node for each node in Stream.
 
    procedure Rebalance_For_Insert
      (Tree : in out Tree_Type;
       Node : Node_Access);
+   --  This rebalances Tree to complete the insertion of Node (which
+   --  must already be linked in at its proper insertion position).
 
 end Ada.Containers.Red_Black_Trees.Generic_Operations;