Changeset 116 for trunk/src/helpers/tree.c

Timestamp:

Nov 1, 2001, 6:43:18 PM (24 years ago)

Author:

umoeller

Message:

More updates.

File:

• trunk/src/helpers/tree.c (modified) (5 diffs)

trunk/src/helpers/tree.c

@@ -285 +285 @@
  *      initializes the root of a tree.
  *
+ *      If (plCount != NULL), *plCount is set to null also.
+ *      This same plCount pointer can then be passed to
+ *      treeInsert and treeDelete also to automatically
+ *      maintain a tree item count.
+ *
  *@@changed V0.9.16 (2001-10-19) [umoeller]: added plCount
  */
@@ -509 +514 @@
  *      "x" specifies the new tree node which must
  *      have been allocated by the caller. x->ulKey
- *      must already contain the node's key (data).
+ *      must already contain the node's key (data)
+ *      which the sort function can understand.
+ *
  *      This function will then set the parent,
- *      left, right, and color members.
+ *      left, right, and color members. In addition,
+ *      if (plCount != NULL), *plCount is raised by
+ *      one.
  *
  *      Returns 0 if no error. Might return
@@ -521 +530 @@
 
 int treeInsert(TREE **root,                     // in: root of the tree
-               PLONG plCount,                 // in/out: item count (ptr can be NULL)
+               PLONG plCount,                   // in/out: item count (ptr can be NULL)
                TREE *x,                         // in: new node to insert
                FNTREE_COMPARE *pfnCompare)      // in: comparison func
@@ -750 +759 @@
  *      Does not free() the node though.
  *
+ *      In addition, if (plCount != NULL), *plCount is
+ *      decremented.
+ *
  *      Returns 0 if the node was deleted or
  *      STATUS_INVALID_NODE if not.
@@ -757 +769 @@
 
 int treeDelete(TREE **root,         // in: root of the tree
-               PLONG plCount,     // in/out: item count (ptr can be NULL)
+               PLONG plCount,       // in/out: item count (ptr can be NULL)
                TREE *tree)          // in: tree node to delete
 {