RBtree-debug.c

#include "RBtree.h"
#include "RBtree_priv.h"
#include <stdlib.h>
#include <stdio.h>
#include <limits.h>
#ifdef DEBUG
#	define eprintf(...) fprintf(stderr, __VA_ARGS__)
#else
#	define eprintf(...) ((void)0)
#endif



/******************************************************************************
 * Section 1: Creation and Deallocation
 *****************************************************************************/
/* Creates an empty Red-Black tree. */
rb_tree RBcreate() {
	rb_tree ret; /* The tree we are returning */
	if ((ret = malloc(sizeof(*ret))) == NULL) {
		fprintf(stderr, "Error: out of memory.\n");
		return NULL;
	}
	/* We can't use rb_new_node() because it wants to set some of the values
	 * to tree->nil. */
	if ((ret->nil = malloc(sizeof(*ret->nil))) == NULL) {
		fprintf(stderr, "Error: out of memory.\n");
		/* Allocation of ret had been successful; we need to free it. */
		free(ret);
		return NULL;
	}
	eprintf("> tree->nil is at %p\n", (void *)ret->nil);
	ret->nil->color = 'b';
	ret->nil->lchild = ret->nil;
	ret->nil->rchild = ret->nil;
	ret->nil->parent = ret->nil;
	ret->root = ret->nil;
	return ret;
}
/* Frees an entire tree. */
void RBfree(rb_tree tree) {
	rb_free_subtree(tree, tree->root);
	rb_free_node(tree->nil);
	free(tree);
}
/* Helper routine: frees a subtree rooted at specified node. */
static void rb_free_subtree(rb_tree tree, rb_node node) {
	if (node == tree->nil) return; /* We only free tree->nil once */
	rb_free_subtree(tree, node->lchild);
	rb_free_subtree(tree, node->rchild);
	rb_free_node(node);
}
/* Creates a new node. */
static rb_node rb_new_node(rb_tree tree, int data) {
	rb_node ret;
	/* We take nodes from the memory pool if we can; else just allocate it. */
	if (rb_mem_pool != NULL) {
		eprintf("> Allocation: reusing node %d(%c) at %p\n",
				rb_mem_pool->key, rb_mem_pool->color,
				(void *)rb_mem_pool);
		ret = rb_mem_pool;
		rb_mem_pool = ret->parent;
	} else {
		eprintf("> Allocation: calling malloc\n");
		/* Allocate it with malloc() */
		if ((ret = malloc(sizeof(*ret))) == NULL) {
			fprintf(stderr, "Error: out of memory.\n");
			return NULL;
		}
		eprintf("> malloc successful! got %p\n", (void *)ret);
	}
	ret->key = data;
	ret->parent = tree->nil;
	ret->lchild = tree->nil;
	ret->rchild = tree->nil;
	ret->color = 'r';
	return ret;
}
/* Frees a node to the memory pool. */
static void rb_free_node(rb_node node) {
	eprintf("> Deallocating node %i(%c) at %p\n", node->key,
			node->color, (void *)node);
	node->parent = rb_mem_pool;
	rb_mem_pool = node;
}
/* Frees entire memory pool to main memory. */
void RBcleanup() {
	while (rb_mem_pool != NULL) {
		rb_node cur = rb_mem_pool;
		eprintf(">Freeing node %i(%c) at %p\n", cur->key, cur->color,
				(void *)cur);
		rb_mem_pool = cur->parent;
		free(cur);
	}
}




/******************************************************************************
 * Section 2: Insertion
 *****************************************************************************/
/* Inserts an element with specified key into tree. */
int RBinsert(rb_tree tree, int key) {
	/* The node we will create */
	rb_node newnode;
	/* newnode's parent */
	rb_node newparent = tree->nil;
	/* The position into which we will put newnode */
	rb_node pos = tree->root;
	/* Locate the correct position */
	while (pos != tree->nil) {
		newparent = pos;
		if (key < pos->key) {
			pos = pos->lchild;
		} else if (key > pos->key) {
			pos = pos->rchild;
		} else {
			/* We don't support two nodes with the same value. */
			fprintf(stderr, "Error: node %i already in the tree.\n", key);
			return 0;
		}
	}
	/* Allocate our node */
	newnode = rb_new_node(tree, key);
	if (newnode == NULL) {
		return 0;
	}
	/* Set up the parent node */
	newnode->parent = newparent;
	if (newparent == tree->nil) {
		tree->root = newnode;
	} else if (key < newparent->key) {
		newparent->lchild = newnode;
	} else {
		newparent->rchild = newnode;
	}
	/* Fix the tree structure */
	rb_insert_fix(tree, newnode);
	return 1;
}
/* Corrects for properties violated on an insertion. */
static void rb_insert_fix(rb_tree tree, rb_node n) {
	rb_node gp = n->parent->parent, /* grandparent */
		uncle = rb_get_uncle(tree, n);
	/* Case 1: uncle is colored red */
	while (n->parent->color == 'r' && uncle->color == 'r') {
		/* If gp were null, then n->parent would be the root node (or
		 * tree->nil), and would have to have been black. */
		eprintf(">> Insertion case 1: %d(%c), with uncle %d(%c)\n", n->key,
				n->color, uncle->key, uncle->color);
		gp->color = 'r';
		uncle->color = 'b';
		n->parent->color = 'b';
		n = gp;
		gp = n->parent->parent;
		uncle = rb_get_uncle(tree, n);
	}
	
	eprintf(">> Insertion case 1 taken care of, on %d(%c) with parent %d(%c)\n",
			n->key, n->color, n->parent->key, n->parent->color);
	if (n->parent->color == 'b') {
		if (n == tree->root) n->color = 'b';
		return;
	}

	/* Case 2: node is "close to" uncle */
	if ((n->parent->lchild == n) == (gp->lchild == uncle)) {
		rb_node new_n = n->parent;
		eprintf(">> Insertion case 2: %d(%c), with uncle %d(%c)\n", n->key,
				n->color, uncle->key, uncle->color);
		rb_rotate(tree, new_n, new_n->rchild == n);
		n = new_n;
	} /* Fall through */
	/* Case 3: node is "far from" uncle */
	eprintf(">> Insertion case 3: %d(%c), with uncle %d(%c)\n", n->key, n->color,
			uncle->key, uncle->color);
	n->parent->color = 'b';
	gp->color = 'r';
	rb_rotate(tree, gp, gp->lchild == uncle);
	tree->root->color = 'b';
}
/* Helper routine: returns the uncle of a given node. */
static rb_node rb_get_uncle(rb_tree tree, rb_node n) {
	rb_node gp;
	if (n->parent == tree->nil || n->parent->parent == tree->nil) {
		return tree->nil;
	}
	gp = n->parent->parent;
	return (gp->lchild == n->parent) ? gp->rchild : gp->lchild;
}




/******************************************************************************
 * Section 3: Deletion
 *****************************************************************************/
/* Deletes an element with a particular key. */
int RBdelete(rb_tree tree, int key) {
	/* The node with the actual key */
	rb_node dead = rb_get_node_by_key(tree, key);
	/* The node where we will fix the tree structure */
	rb_node fixit;
	/* Original color of the deleted node */
	char orig_col = dead->color;
	/* Node does not exist, so we cannot delete it */
	if (dead == tree->nil) {
		fprintf(stderr, "Error: node %i does not exist.\n", key);
		return 0;
	}
	/* Here we perform binary tree deletion */
	eprintf("> Deleting node %d(%c)\n", dead->key, dead->color);
	if (dead->lchild == tree->nil) {
		fixit = dead->rchild;
		rb_transplant(tree, dead, fixit);
	} else if (dead->rchild == tree->nil) {
		fixit = dead->lchild;
		rb_transplant(tree, dead, fixit);
	} else {
		/* Replace dead with its successor */
		rb_node successor = rb_min(tree, dead->rchild);
		orig_col = successor->color;
		fixit = successor->rchild;
		if (successor->parent == dead) {
			fixit->parent = successor;
		} else {
			/* Put the successor's right child into its place */
			rb_transplant(tree, successor, successor->rchild);
			successor->rchild = dead->rchild;
			successor->rchild->parent = successor;
		}
		rb_transplant(tree, dead, successor);
		successor->lchild = dead->lchild;
		successor->lchild->parent = successor;
		successor->color = dead->color;
	}
	rb_free_node(dead);
	/* Only need to fix if we deleted a black node */
	RBdraw(tree, "test.svg");
	if (orig_col == 'b') {
		eprintf(">> Fixing tree at node %d(%c) with parent %d(%c)\n",
			fixit->key, fixit->color, fixit->parent->key, fixit->parent->color);
		rb_delete_fix(tree, fixit);
	}
	return 1;
}
/* Helper routine: transplants node `from' into node `to's position. */
static void rb_transplant(rb_tree tree, rb_node to, rb_node from) {
	if (to->parent == tree->nil) {
		tree->root = from;
	} else if (to == to->parent->lchild) {
		to->parent->lchild = from;
	} else {
		to->parent->rchild = from;
	}
	from->parent = to->parent;
}
/* Corrects for properties violated on a deletion. */
static void rb_delete_fix(rb_tree tree, rb_node n) {
	/* It's always safe to change the root black, and if we reach a red
	 * node, we can fix the tree by changing it black. */
	while (n != tree->root && n->color == 'b') {
		/* Instead of duplicating code, we just have a flag to test
		 * which direction we are dealing with. */
		int is_left = (n == n->parent->lchild);
		rb_node sibling = (is_left) ? n->parent->rchild : n->parent->lchild;
		/* Case 1: sibling red */
		if (sibling->color == 'r') {
			eprintf(">> Deletion case 1: %d(%c), with sibling %d(%c)\n",
					n->key, n->color, sibling->key, sibling->color);
			sibling->color = 'b';
			sibling->parent->color = 'r';
			rb_rotate(tree, sibling->parent, is_left);
			sibling = (is_left) ? n->parent->rchild : n->parent->rchild;
		}
		/* Case 2: sibling black, both sibling's children black */
		if (sibling->lchild->color == 'b' && sibling->rchild->color == 'b') {
			eprintf(">> Deletion case 2: %d(%c), with sibling %d(%c) "
					"(sibling's kids %d(%c), %d(%c))\n",
					n->key, n->color, sibling->key, sibling->color,
					sibling->lchild->key, sibling->lchild->color,
					sibling->rchild->key, sibling->rchild->color);
			/* Push the "extra black" up the tree */
			sibling->color = 'r';
			n = n->parent;
		} else {
			/* Case 3: sibling black, "far" child black */
			if (( is_left && sibling->rchild->color == 'b') ||
			    (!is_left && sibling->lchild->color == 'b')) {
				eprintf(">> Deletion case 3: %d(%c), with sibling %d(%c) "
					"(sibling's kids %d(%c), %d(%c))\n",
					n->key, n->color, sibling->key, sibling->color,
					sibling->lchild->key, sibling->lchild->color,
					sibling->rchild->key, sibling->rchild->color);
				if (is_left) {
					sibling->lchild->color = 'b';
				} else {
					sibling->rchild->color = 'b';
				}
				sibling->color = 'r';
				rb_rotate(tree, sibling, !is_left);
				eprintf(">>> Rotated!\n");
				eprintf(">> Current state of affairs: %d(%c), with sibling %d(%c) "
					"(sibling's kids %d(%c), %d(%c))\n"
					"                 (my parent %d(%c), sibling parent %d(%c))\n",
					n->key, n->color, sibling->key, sibling->color,
					sibling->lchild->key, sibling->lchild->color,
					sibling->rchild->key, sibling->rchild->color,
					n      ->parent->key, n      ->parent->color,
					sibling->parent->key, sibling->parent->color);
				sibling = (is_left) ? n->parent->rchild : n->parent->lchild;
				eprintf(">>> New sibling: %d(%c)\n", sibling->key, sibling->color);
				eprintf(">>> Sibling has: lc: %d; rc: %d\n", (sibling->lchild != NULL),
						(sibling->rchild != NULL));
				RBdraw(tree, "test2.svg");
			} /* Fall through */
			/* Case 4: sibling black, "far" child red */
			eprintf(">> Deletion case 4: %d(%c), with sibling %d(%c) "
					"(sibling's kids %d(%c), %d(%c))\n",
					n->key, n->color, sibling->key, sibling->color,
					sibling->lchild->key, sibling->lchild->color,
					sibling->rchild->key, sibling->rchild->color);
			sibling->color = n->parent->color;
			n->parent->color = 'b';
			if (is_left) {
				sibling->rchild->color = 'b';
			} else {
				sibling->lchild->color = 'b';
			}
			rb_rotate(tree, n->parent, is_left);
			/* We're done, so set n to the root node */
			n = tree->root;
		}
	}
	n->color = 'b';
}




/******************************************************************************
 * Section 4: I/O
 *****************************************************************************/
/* Writes a tree to stdout in preorder format. */
void RBwrite(rb_tree tree) {
	if (tree->root == tree->nil) {
		fprintf(stderr, "Error: empty tree\n");
		return;
	}
	/* Special case to account for missing semicolon */
	printf("%c, %d", tree->root->color, tree->root->key);
	rb_preorder_write(tree, tree->root->lchild);
	rb_preorder_write(tree, tree->root->rchild);
	putchar('\n');
}
/* Helper routine: write an entire subtree to stdout. */
static void rb_preorder_write(rb_tree tree, rb_node n) {
	if (n == tree->nil) return;
	/* Instead of having to keep track of "is this the last node or not?",
	 * we just print the first node with no semicolon, then print the
	 * semicolon BEFORE the other nodes. */
	printf("; %c, %d", n->color, n->key);
	rb_preorder_write(tree, n->lchild);
	rb_preorder_write(tree, n->rchild);
}
/* Reads a tree in preorder format from RBREADFILE. */
/* This function implements an algorithm which is O(n) in the number of nodes,
 * more efficient than the trivial O(n*log(n)) algorithm. */
rb_tree RBread(char *fname) {
	rb_tree ret;
	rb_node root;
	FILE *infp = fopen(fname, "r");
	if (infp == NULL) {
		fprintf(stderr, "Error: couldn't read file %s.\n", fname);
		return NULL;
	}
	/* Create the tree to return */
	ret = RBcreate();
	if (ret != NULL) {
		root = rb_read_node(ret, infp);
		/* Read in nodes from negative infinity to INT_MAX. */
		ret->root = rb_read_subtree(ret, &root, INT_MAX, infp);
	}
	fclose(infp);
	return ret;
}
/* Reads a tree in preorder format, limited by the maximum value of max. */
static rb_node rb_read_subtree(rb_tree tree, rb_node *next, int max, FILE *fp) {
	rb_node ret = *next;
	/* Either the tree is complete or we don't belong here */
	if (ret == NULL || ret->key > max) {
		return tree->nil;
	}
	*next = rb_read_node(tree, fp);
	/* Nodes up to my own value belong to my left subtree */
	ret->lchild = rb_read_subtree(tree, next, ret->key - 1, fp);
	ret->lchild->parent = ret;
	/* Nodes up to my maximum belong to my right subtree */
	ret->rchild = rb_read_subtree(tree, next, max, fp);
	ret->rchild->parent = ret;
	return ret;
}
/* Helper routine: read a single node from file fp. */
static rb_node rb_read_node(rb_tree tree, FILE *fp) {
	rb_node n; /* the node to return */
	char col;  /* the color of the node */
	int data;  /* the data of the node */
	/* Skip optional semicolon */
	fscanf(fp, " ; ");
	/* If node is invalid (or we've reached EOF), die a painful death */
	if (fscanf(fp, " %c, %d ", &col, &data) != 2 || (col != 'b' && col != 'r')) {
		return NULL;
	}
	n = rb_new_node(tree, data);
	if (n != NULL) n->color = col;
	return n;
}




/******************************************************************************
 * Section 5: General helper routines
 *****************************************************************************/
/* Returns a node with the given key. */
static rb_node rb_get_node_by_key(rb_tree haystack, int needle) {
	rb_node pos = haystack->root; /* our current position */
	while (pos != haystack->nil) {
		eprintf(">> Passing through %d(%c)\n", pos->key,
				pos->color);
		if (pos->key == needle) {
			return pos;
		} else if (needle < pos->key) {
			pos = pos->lchild;
		} else {
			pos = pos->rchild;
		}
	}
	return haystack->nil;
}
/* Rotates a tree around the given root. */
static void rb_rotate(rb_tree tree, rb_node root, int go_left) {
	/* Instead of duplicating code, we just
	 * have a flag to indicate the direction to rotate. */
	/* The new top node */
	rb_node newroot = (go_left) ? root->rchild : root->lchild;
	eprintf("  >> rb_rotate: root %d(%c), newroot %d(%c), left %d\n",
			root->key, root->color, newroot->key, newroot->color, go_left);
	eprintf("       parent %d(%c), lc %d(%c), rc %d(%c)\n",
			root->parent->key, root->parent->color,
			root->parent->lchild->key, root->parent->lchild->color,
			root->parent->rchild->key, root->parent->rchild->color);

	/* We swap the center child and the old top node */
	if (go_left) {
		root->rchild = newroot->lchild;
		if (root->rchild != tree->nil) {
			root->rchild->parent = root;
		}
		newroot->lchild = root;
	} else {
		root->lchild = newroot->rchild;
		if (root->lchild != tree->nil) {
			root->lchild->parent = root;
		}
		newroot->rchild = root;
	}
	/* Now we set up the parent nodes */
	newroot->parent = root->parent;
	root->parent = newroot;
	/* We update old top node's parent to point to the new top node */
	if (newroot->parent == tree->nil) {
		tree->root = newroot;
	} else if (newroot->parent->lchild == root) {
		newroot->parent->lchild = newroot;
	} else {
		newroot->parent->rchild = newroot;
	}
	eprintf("  >> rb_rotate: oldroot %d(%c), newroot %d(%c)\n"
		"       oldroot children: left ", root->key, root->color,
		newroot->key, newroot->color);
	if (root->lchild != NULL) {
		eprintf("%d(%c), ", root->lchild->key, root->lchild->color);
	} else {
		eprintf("DNE,  ");
	}
	eprintf("right ");
	if (root->rchild != NULL) {
		eprintf("%d(%c)\n", root->rchild->key, root->rchild->color);
	} else {
		eprintf("DNE\n");
	}
	eprintf("       newroot children: left ");
	if (newroot->lchild != NULL) {
		eprintf("%d(%c), ", newroot->lchild->key, newroot->lchild->color);
	} else {
		eprintf("DNE,  ");
	}
	eprintf("right ");
	if (newroot->rchild != NULL) {
		eprintf("%d(%c)\n", newroot->rchild->key, newroot->rchild->color);
	} else {
		eprintf("DNE\n");
	}
	eprintf("       parent %d(%c), lc %d(%c), rc %d(%c)\n",
			newroot->parent->key, newroot->parent->color,
			newroot->parent->lchild->key, newroot->parent->lchild->color,
			newroot->parent->rchild->key, newroot->parent->rchild->color);
}
/* Returns minimum node in the given subtree. */
static rb_node rb_min(rb_tree tree, rb_node node) {
	while (node->lchild != tree->nil)
		node = node->lchild;
	return node;
}
/* Computes height of the tree rooted at node n. */
static int rb_height(rb_tree tree, rb_node n) {
	int l, r;
	if (n == tree->nil) return 0;
	l = rb_height(tree, n->lchild);
	r = rb_height(tree, n->rchild);
	return 1 + ((l > r) ? l : r);
}




/******************************************************************************
 * Section 6: SVG
 *****************************************************************************/
/* Draws an SVG picture of the tree in the specified file. */
void RBdraw(rb_tree tree, char *fname) {
	FILE *fp; /* file to print to */
	int height = rb_height(tree, tree->root); /* height of the tree */
	int width; /* width of the image */
	int adjwidth; /* adjusted width of the image in px */
	double factor; /* adjust factor for the node positions based on width and adjwidth */
	eprintf(">> Creating drawing %s, of height %d nodes.\n", fname, height);
	if (height == 0) return;
	if ((fp = fopen(fname, "w")) == NULL) {
		fprintf(stderr, "Error: couldn't open %s for writing.\n", fname);
		return;
	}
	width = (1<<(height-1)) * (2*RADIUS + PADDING) - PADDING + 2*IMGBORDER;
	adjwidth = (width > MAXWIDTH) ? MAXWIDTH : width;
	/* If it weren't for this factor, calculations would be a lot easier. */
	factor = (height == 1) ? 1.0 : (adjwidth-2*(RADIUS+IMGBORDER)) / (width-2*(RADIUS+IMGBORDER));
	eprintf(">> Opened %s for writing. Tree height = %d, image width = %d, "
			"factor = %f.\n", fname, height, width, factor);
	fprintf(fp, "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n"
		"<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n"
		"<svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" width=\"%dpx\" height=\"%dpx\" "
		"style=\"background-color:white\">\n",
		adjwidth, (int)(height * (2*RADIUS + PADDING) - PADDING + 2*IMGBORDER));
	rb_draw_subtree(fp, tree, tree->root, calcpos(height-1, 0, factor), RADIUS+IMGBORDER, height-1, 0, factor);
	fputs("</svg>\n", fp);
	eprintf(">> Finished drawing %s.\n", fname);
	fclose(fp);
}
/* This method has complicated and seemingly-arbitrary arguments to reduce on
 * computation. It's a private method, so I feel justified in making it hard to
 * call.
 *
 * Arguments are:
 * fp     - file pointer to print to
 * tree   - red-black tree to print
 * n      - current node
 * x      - correct x position of center of node
 * y      - correct y position of center of node
 * h      - distance from bottom of tree (not necessarily the height of this
 *          particular node)
 * rowpos - position in layer (leftmost node in layer is 0, then 1, etc.)
 * factor - correction factor when the image is > MAXWIDTH.
 */
static void rb_draw_subtree(FILE *fp, rb_tree tree, rb_node n, double x, double y,
		int h, int rowpos, double factor) {
	/* string for the color of the node */
	char *col = (n->color == 'b') ? "black" : "red";
	/* y position for next row */
	double ny = y + 2*RADIUS + PADDING;

	/* Draw left subtree */
	if (n->lchild != tree->nil) {
		/* x position of left child */
		double nx = calcpos(h-1, 2*rowpos, factor);
		fprintf(fp, "<line x1=\"%f\" y1=\"%f\" x2=\"%f\" y2=\"%f\" "
			"style=\"stroke:black;stroke-width:1\"/>\n",
			x, y, nx, ny);
		rb_draw_subtree(fp, tree, n->lchild, nx, ny, h-1, 2*rowpos, factor);
	}
	/* Draw right subtree */
	if (n->rchild != tree->nil) {
		/* x position of right child */
		double nx = calcpos(h-1, 2*rowpos+1, factor);
		fprintf(fp, "<line x1=\"%f\" y1=\"%f\" x2=\"%f\" y2=\"%f\" "
			"style=\"stroke:black;stroke-width:1\"/>\n",
			x, y, nx, ny);
		rb_draw_subtree(fp, tree, n->rchild, nx, ny, h-1, 2*rowpos+1, factor);
	}
	/* Draw the node itself */
	fprintf(fp, "<circle cx=\"%f\" cy=\"%f\" r=\"%f\" stroke=\"black\" "
		"stroke-width=\"1\" fill=\"%s\"/>\n", x, y, RADIUS, col);
	/* And write the node key */
	fprintf(fp, "<text x=\"%f\" y=\"%f\" fill=\"white\" text-anchor=\"middle\" "
		"dy=\"0.5ex\">%d</text>\n", x, y, n->key);
}
/* Calculates x position of circle exp rows from the bottom, at position rowpos
 * in its row. factor corrects for an image which would be wider than MAXWIDTH. */
static double calcpos(int exp, int rowpos, double factor) {
	/* This equation took quite a bit of diagramming on paper to come up with. */
	return ((1<<exp) * (2*rowpos+1) - 1) * (RADIUS + PADDING/2) * factor + RADIUS + IMGBORDER;
}