From d065440d5acc0c549729b5cc9e658e66e03f1a43 Mon Sep 17 00:00:00 2001
From: vsc <vsc@b08c6af1-5177-4d33-ba66-4b1c6b8b522a>
Date: Tue, 18 Jun 2002 04:23:15 +0000
Subject: [PATCH] add documentation on rbtrees.

git-svn-id: https://yap.svn.sf.net/svnroot/yap/trunk@543 b08c6af1-5177-4d33-ba66-4b1c6b8b522a
---
 changes4.3.html     |  5 +++++
 docs/yap.tex        | 50 ++++++++++++++++++++++++++++++++++++++++++---
 library/rbtrees.yap |  2 ++
 3 files changed, 54 insertions(+), 3 deletions(-)

diff --git a/changes4.3.html b/changes4.3.html
index c27200c89..978896f61 100644
--- a/changes4.3.html
+++ b/changes4.3.html
@@ -16,6 +16,11 @@
 
 <h2>Yap-4.3.23:</h2>
 <ul>
+
+	<li>UPDATE: include new apply_macros code from Erick Alphonse,
+	and acknowledge J. Schimpf</li>
+	<li>FIXED: YapRunGoal (Roberto Bagnara)</li>
+	<li>NEW: term_position option for read_term (Nicos)</li>
 	<li>UPDATE: fixed shell/1 and shell/2 in library(system). (Nicos)</li>
 	<li>UPDATE: new Logtalk version (2.13.0).</li>
 	<li>FIXED: <code>\newline</code> in strings (Roberto Bagnara). </li>
diff --git a/docs/yap.tex b/docs/yap.tex
index f24116fb9..65094c0a8 100644
--- a/docs/yap.tex
+++ b/docs/yap.tex
@@ -219,6 +219,7 @@ Subnodes of Library
 * Pseudo Random:: Pseudo Random Numbers
 * Queues:: Queue Manipulation
 * Random:: Random Numbers
+* Red-Black Trees:: Predicates to add, lookup and delete in red-black binary  trees.
 * RegExp:: Regular Expression Manipulation
 * Splay Trees:: Splay Trees
 * String I/O:: Writing To and Reading From Strings
@@ -6470,6 +6471,7 @@ Library, Extensions, Builtins, Top
 * Pseudo Random:: Pseudo Random Numbers
 * Queues:: Queue Manipulation
 * Random:: Random Numbers
+* Red-Black Trees:: Predicates to add, lookup and delete in red-black binary  trees.
 * RegExp:: Regular Expression Manipulation
 * Splay Trees:: Splay Trees
 * String I/O:: Writing To and Reading From Strings
@@ -6691,7 +6693,8 @@ predicates library uses code originally written by Martin van Emdem and
 published in the Logic Programming Newsletter, Autumn 1981.  A bug in
 this code was fixed by Philip Vasey, in the Logic Programming
 Newsletter, Summer 1982. The library currently only includes routines to
-insert and lookup elements in the tree.
+insert and lookup elements in the tree. Please try red-black trees if
+you need deletion.
 
 @table @code
 @item avl_insert(+@var{Key},?@var{Value},+@var{T0},+@var{TF})
@@ -7214,7 +7217,7 @@ Creates a new list with the same elements as @var{Queue}.
 @end table
 
 
-@node Random, RegExp, Queues, Library
+@node Random, Red-Black Trees, Queues, Library
 @section Random Number Generator
 @cindex queue
 
@@ -7273,7 +7276,48 @@ random number generator. The integer @code{X} must be in the range
 
 @end table
 
-@node RegExp, Splay Trees, Random, Library
+@node Red-Black Trees, RegExp, Random, Library
+@section Red-Black Trees
+@cindex Red-Black Trees
+
+Red-Black trees are balanced search binary trees. They are named because
+nodes can be classified as either red or black. The code we include is
+based on "Introduction to Algorithms", second edition, by Cormen,
+Leiserson, Rivest and Stein.  The library includes routines to insert,
+lookup and delete elements in the tree.
+
+@table @code
+@item insert(+@var{T0},+@var{Key},?@var{Value},+@var{TF})
+@findex insert/4
+@snindex insert/4
+@cnindex insert/4
+Add an element with key @var{Key} and @var{Value} to the tree
+@var{T0} creating a new AVL tree @var{TF}. Duplicated elements are not
+allowed.
+
+@item lookup(+@var{Key},-@var{Value},+@var{T})
+@findex lookup/3
+@snindex lookup/3
+@cnindex lookup/3
+Lookup an element with key @var{Key} in the AVL tree
+@var{T}, returning the value @var{Value}.
+
+@item new(?@var{T})
+@findex new/1
+@snindex new/1
+@cnindex new/1
+Create a new tree.
+
+@item delete(+@var{T},+@var{Key},-@var{TN})
+@findex delete/3
+@snindex delete/3
+@cnindex delete/3
+Delete element with key @var{Key} from the tree @var{T}, returning a new
+tree @var{TN}.
+
+@end table
+
+@node RegExp, Splay Trees, Red-Black Trees, Library
 @section Regular Expressions
 @cindex regular expressions
 
diff --git a/library/rbtrees.yap b/library/rbtrees.yap
index 183a2bda0..9047674af 100644
--- a/library/rbtrees.yap
+++ b/library/rbtrees.yap
@@ -6,6 +6,8 @@
 	Cormen, Leiserson, Rivest, and Stein,
 	MIT Press
 
+        Author: Vitor Santos Costa
+
 */