12 static void _trap(int line)
15 printf("Trapped from line %d, use debugger to get backtrace\n",
22 #define trap() _trap(__LINE__)
24 static int quadtree_compare_coord(const struct vector *a,
25 const struct vector *b)
41 static int quadtree_compare(const struct quadtree *a, const struct quadtree *b)
43 return quadtree_compare_coord(&a->pos, &b->pos);
46 static void validate_subtree(const struct quadtree *node)
53 printf("Attempted to validate a null pointer\n");
58 for (i = 0; i < 4; i++) {
62 if (node->child[i]->parent != node) {
63 printf("%s:%d Fatal! Tree inconsistency detected at "
64 "child %d %p in node %p, incorrent parent %p\n",
65 __func__, __LINE__, i, node->child[i], node,
66 node->child[i]->parent);
72 if (node->child[i] == node->parent) {
73 printf("%s:%d Fatal! Tree loop detected "
74 "at child %d in node %p\n",
75 __func__, __LINE__, i, node);
81 dir = quadtree_compare(node, node->child[i]);
84 printf("%s:%d Fatal! Spatial inconsistency detected "
85 "at child %d in node %p\n"
86 "parent: (%f %f), child (%f %f), "
88 __func__, __LINE__, i, node,
89 node->pos.x, node->pos.y,
90 node->child[i]->pos.x, node->child[i]->pos.y,
96 children += node->child[i]->children + 1;
98 validate_subtree(node->child[i]);
101 if (node->depth < 0) {
102 printf("%s:%d Tree statistics inconsistency detected! "
103 "Negative depth: %ld\n",
104 __func__, __LINE__, node->depth);
107 if (node->children != children) {
108 printf("%s:%d Tree statistics inconsistency detected! "
109 "child count mismatch. Expected %ld, got %ld\n",
110 __func__, __LINE__, children, node->children);
115 for (i = 0; i < 4 && node->children; i++) {
119 if (node->depth == node->child[i]->depth + 1)
122 if (node->child[i]->depth > node->depth) {
123 printf("%s:%d Tree statistics inconsistency detected! "
124 "child depth mismatch %ld > %ld\n",
125 __func__, __LINE__, node->child[i]->depth,
131 printf("%s:%d Tree statistics inconsistency detected! "
132 "child depth mismatch.",
139 static void validate_tree(const struct quadtree *node)
147 return validate_subtree(node);
149 for (i = 0; i < 4; i++)
150 if (node->parent->child[i] == node)
154 printf("%s:%d Tree inconsistency detected! "
155 "Wrong parent %p for node %p\n",
156 __func__, __LINE__, node->parent, node);
161 validate_tree(node->parent);
164 void _quadtree_validate_tree(const struct quadtree *node)
169 static struct quadtree *_quadtree_add(struct quadtree *parent,
170 struct quadtree *new)
174 ret = quadtree_compare(parent, new);
176 if (ret < 0 || ret >= 4) {
177 printf("Invalid comparison result of %d\n", ret);
181 if (parent->child[ret])
182 return _quadtree_add(parent->child[ret], new);
184 parent->child[ret] = new;
185 new->parent = parent;
186 for (i = 0; i < 4; i++)
192 static void _recalculate_node_area_stats(struct quadtree *node)
194 /* The space covered by the parent node's corner
195 * points needs be as wide as its widest child node's
198 #define CHILD_CORNER_SAFE(node, ch_idx, cor_idx, axis) \
199 ((node)->child[ch_idx] ? \
200 (node)->child[ch_idx]->corner[cor_idx].axis : \
203 node->corner[0].x = MIN(CHILD_CORNER_SAFE(node, 0, 0, x),
204 CHILD_CORNER_SAFE(node, 2, 0, x));
205 node->corner[0].y = MIN(CHILD_CORNER_SAFE(node, 0, 0, y),
206 CHILD_CORNER_SAFE(node, 1, 0, y));
207 node->corner[1].x = MAX(CHILD_CORNER_SAFE(node, 1, 1, x),
208 CHILD_CORNER_SAFE(node, 3, 1, x));
209 node->corner[1].y = MAX(CHILD_CORNER_SAFE(node, 2, 1, y),
210 CHILD_CORNER_SAFE(node, 3, 1, y));
211 #undef CHILD_CORNER_SAFE
214 static void recalculate_parent_area_stats(struct quadtree *node)
217 _recalculate_node_area_stats(node);
224 * Recursively walk through the tree and propagate changes made to the
225 * given node up until the highest parent.
227 static void quadtree_recalculate_parent_stats(struct quadtree *node,
228 struct quadtree_ops *ops)
236 for (i = 0; i < 4; i++) {
240 node->depth = MAX(node->depth,
241 node->child[i]->depth + 1);
242 node->children += node->child[i]->children + 1;
245 _recalculate_node_area_stats(node);
247 if (ops->recalculate_stats)
248 ops->recalculate_stats(node);
255 * quadtree_add - add a node to a quadtree
256 * @parent: parent node
257 * @new: the new node to be added
259 * Add a node to a quadtree. The tree is kept in order, the new node
260 * is placed in the end of appropriate branch.
262 * The case of nodes sharing identical coordinates is not taken into
266 struct quadtree *quadtree_add(struct quadtree *parent, struct quadtree *new,
267 struct quadtree_ops *ops)
272 validate_tree(parent);
274 _quadtree_add(parent, new);
277 printf("adding node %p to parent %p\n", new, parent);
281 quadtree_recalculate_parent_stats(new, ops);
288 static int is_within(struct vector *pos, struct vector *corner)
290 if ((pos->x >= corner[1].x) && (pos->x <= corner[0].x) &&
291 (pos->y >= corner[1].y) && (pos->y <= corner[0].y))
296 static int rectangle_and_circle_overlap(struct vector *corner,
297 struct vector *pos, double radius)
299 int vertically_overlapping = 0, horizontally_overlapping = 0;
301 if ((pos->x < corner[1].x && pos->x + radius > corner[0].x) ||
302 (pos->x > corner[0].x && pos->x - radius < corner[1].x))
303 horizontally_overlapping = 1;
305 if ((pos->y < corner[1].y && pos->y + radius > corner[0].y) ||
306 (pos->y > corner[0].y && pos->y - radius < corner[1].y))
307 vertically_overlapping = 1;
309 return horizontally_overlapping && vertically_overlapping;
312 static int quadrants_to_search(struct quadtree *node, struct vector *pos,
320 if (node->child[0] &&
321 rectangle_and_circle_overlap(node->child[0]->corner, pos, dist))
322 direction |= QUADTREE_UPLEFT;
324 if (node->child[1] &&
325 rectangle_and_circle_overlap(node->child[1]->corner, pos, dist))
326 direction |= QUADTREE_UPRIGHT;
328 if (node->child[2] &&
329 rectangle_and_circle_overlap(node->child[2]->corner, pos, dist))
330 direction |= QUADTREE_DOWNLEFT;
332 if (node->child[3] &&
333 rectangle_and_circle_overlap(node->child[3]->corner, pos, dist))
334 direction |= QUADTREE_DOWNRIGHT;
339 static struct quadtree *quadtree_find_nearest(struct quadtree *tree,
341 struct vector *corner,
342 struct quadtree *nearest,
346 struct quadtree *node;
347 double distance = 0, dist;
353 vector_sub(&nearest->pos, pos, &tmp);
354 distance = vector_abs(&tmp);
356 if (!is_within(&nearest->pos, corner)) {
358 printf("Discarding nearest %p "
359 "as outside of search window\n", nearest);
364 directions = quadrants_to_search(tree, pos, distance);
366 printf("%d: Directions: %x\n", depth, directions);
367 for (i = 0; i < 4; i++) {
371 if (!(directions & (1 << i)))
375 node = quadtree_find_nearest(tree->child[i], pos, corner,
381 if (node != nearest) {
382 vector_sub(&node->pos, pos, &tmp);
383 dist = vector_abs(&tmp);
384 if (dist < distance || !nearest) {
389 * Update the directions where to search for
390 * since those may not be valid any more
392 directions = quadrants_to_search(tree, pos, distance);
397 if (nearest && !is_within(&nearest->pos, corner)) {
399 printf("%d: Node %p (%f %f) is not within "
400 "search window (%f %f) (%f %f)\n", depth,
401 nearest, nearest->pos.x, nearest->pos.y,
402 corner[0].x, corner[0].y,
403 corner[1].x, corner[1].y);
407 printf("%d: Node %p (%f %f) is nearest node, dist %f\n",
409 nearest ? nearest->pos.x : -1,
410 nearest ? nearest->pos.y : -1,
411 nearest ? distance : -1);
415 static struct quadtree *quadtree_find_nearest_noparent(struct quadtree *tree,
417 struct vector *corner)
419 struct quadtree *nearest = NULL;
421 struct quadtree *node;
422 double dist = 0, dist2;
425 nearest = quadtree_find_nearest(tree, pos, corner, nearest, 0);
431 printf("Avoiding parent or NULL node %p\n", nearest);
434 * oops, we don't want to pick the parent node, let's choose
438 for (i = 0; i < 4; i++) {
443 nearest = quadtree_find_nearest(tree->child[i], pos,
449 vector_sub(pos, &nearest->pos, &sub);
450 dist = vector_abs(&sub);
453 node = quadtree_find_nearest(tree->child[i], pos, corner,
459 vector_sub(pos, &node->pos, &sub);
460 dist2 = vector_abs(&sub);
472 static void get_middle_point(struct vector *corner, struct vector *middle)
474 middle->x = (corner[0].x + corner[1].x) / (double)2;
475 middle->y = (corner[0].y + corner[1].y) / (double)2;
478 static int quadtree_split_by_node(struct quadtree *node,
479 struct vector *corner, int dir)
481 if (!is_within(&node->pos, corner)) {
483 printf("Not within search rectangle\n");
488 printf("Search rectangle was before (%f %f) (%f %f), (%f %f)\n",
489 corner[0].x, corner[0].y,
490 corner[1].x, corner[1].y,
491 node->pos.x, node->pos.y);
494 case QUADTREE_UPLEFT:
495 corner[0] = node->pos;
497 case QUADTREE_UPRIGHT:
498 corner[0].y = node->pos.y;
499 corner[1].x = node->pos.x;
501 case QUADTREE_DOWNRIGHT:
502 corner[1] = node->pos;
504 case QUADTREE_DOWNLEFT:
505 corner[0].x = node->pos.x;
506 corner[1].y = node->pos.y;
513 printf("Search rectangle is now (%f %f) (%f %f), (%f %f)\n",
514 corner[0].x, corner[0].y,
515 corner[1].x, corner[1].y,
516 node->pos.x, node->pos.y);
518 if ((corner[0].x < corner[1].x) ||
519 (corner[0].y < corner[1].y))
526 * Quickly detach a node from a tree. Move all child nodes under
529 static int _quadtree_del(struct quadtree *node, struct quadtree *parent)
534 /* Detach from the tree */
536 for (i = 0; i < 4; i++) {
537 if (node->parent->child[i] == node) {
538 node->parent->child[i] = 0;
546 for (i = 0; i < 4; i++) {
551 _quadtree_del(n, parent);
552 _quadtree_add(parent, n);
553 recalculate_parent_area_stats(n);
560 * Move everything under @tree node to @parent node, everything
561 * else except the @tree node itself
563 static int optimally_move_tree(struct quadtree *tree, struct quadtree *parent,
564 struct vector *corner_orig,
565 struct quadtree_ops *ops)
567 struct vector corner[2], mid;
568 struct quadtree *t, *tmp;
571 get_middle_point(corner_orig, &mid);
572 t = quadtree_find_nearest_noparent(tree, &mid, corner_orig);
576 printf("Cannot find nearest node\n");
582 * Now we have the t node which contains the object of the
583 * spatial middle coordinates of the tree.
587 printf("Relocating node %p (%f %f) under parent %p\n", t,
588 t->pos.x, t->pos.y, parent);
589 printf("There are %ld child nodes left\n", tree->children);
592 _quadtree_del(t, tree);
593 quadtree_add(parent, t, ops);
601 * Now split the search rectangle in quadtres and do the same
602 * with all of the quarters.
605 corner[0] = corner_orig[0];
606 corner[1] = corner_orig[1];
607 if (quadtree_split_by_node(t, corner, QUADTREE_UPLEFT))
608 moved += optimally_move_tree(tree, parent, corner, ops);
610 corner[0] = corner_orig[0];
611 corner[1] = corner_orig[1];
612 if (quadtree_split_by_node(t, corner, QUADTREE_UPRIGHT))
613 moved += optimally_move_tree(tree, parent, corner, ops);
615 corner[0] = corner_orig[0];
616 corner[1] = corner_orig[1];
617 if (quadtree_split_by_node(t, corner, QUADTREE_DOWNLEFT))
618 moved += optimally_move_tree(tree, parent, corner, ops);
620 corner[0] = corner_orig[0];
621 corner[1] = corner_orig[1];
622 if (quadtree_split_by_node(t, corner, QUADTREE_DOWNRIGHT))
623 moved += optimally_move_tree(tree, parent, corner, ops);
627 printf("Now moved %d nodes, %ld left\n", moved, tree->children);
633 * quadtree_del - Detach a node from the tree
635 * Return value: The new root node of the tree. If we are detaching
636 * anything but the root node of the entire tree, the returned root
637 * value will be the original root of the tree.
639 struct quadtree *quadtree_del(struct quadtree *node,
640 struct quadtree_ops *ops)
642 struct quadtree *parent = NULL;
643 struct vector corner[2];
644 int i, children = node->children, moved;
649 printf("Deleting node %p under parent %p\n",
651 printf("Relocating %ld children\n", node->children);
657 * We are deleting the root node. This means we have
658 * to select a new root node and reconstruct the
659 * entire tree under it again.
662 printf("Deleting root node\n");
665 for (i = 0; i < 4; i++) {
669 parent = node->child[i];
670 _quadtree_del(parent, node);
672 quadtree_recalculate_parent_stats(parent, ops);
677 * The node has a parent. Detach the node from it and
678 * relocate the children.
681 for (i = 0; i < 4; i++) {
682 if (node->parent->child[i] == node) {
683 node->parent->child[i] = 0;
690 parent = node->parent;
694 * The sub branch is now detached from the main
695 * tree. Fix the stats.
697 quadtree_recalculate_parent_stats(parent, ops);
700 validate_tree(parent);
705 * Now we are ready to prepare for relocating the nodes under
709 corner[0] = node->corner[1];
710 corner[1] = node->corner[0];
712 printf("\nInitial Search rectangle (%f %f) (%f %f), (%f %f)\n",
713 corner[0].x, corner[0].y,
714 corner[1].x, corner[1].y,
715 node->pos.x, node->pos.y);
718 moved = optimally_move_tree(node, parent, corner, ops);
721 if (moved != children) {
722 printf("Got %d children but %d were moved\n",
724 printf("nearest children left:\n");
725 for (i = 0 ; i < 4; i++)
727 printf(" node %d %p, (%f %f)\n",
729 node->child[i]->pos.x,
730 node->child[i]->pos.y);
734 printf("Delete done, returning parent %p\n", parent);
739 validate_tree(parent);
740 return quadtree_find_parent(parent);
743 static void check_for_crossed_subnodes(struct quadtree *node,
744 struct vector *limit, struct quadtree_ops *ops)
746 int direction = 0, i;
747 int up = 0, left = 0, right = 0, down = 0;
749 for (i = 0; i < 2; i++) {
750 if (limit[i].x < node->pos.x)
754 if (limit[i].y < node->pos.y)
761 direction |= QUADTREE_UPLEFT;
763 direction |= QUADTREE_UPRIGHT;
765 direction |= QUADTREE_DOWNLEFT;
767 direction |= QUADTREE_DOWNRIGHT;
768 if ((left && right) || (up && down))
769 direction |= QUADTREE_SELF;
771 if ((direction & QUADTREE_UPLEFT) && node->child[0])
772 check_for_crossed_subnodes(node->child[0], limit, ops);
774 if ((direction & QUADTREE_UPRIGHT) && node->child[1])
775 check_for_crossed_subnodes(node->child[0], limit, ops);
777 if ((direction & QUADTREE_DOWNLEFT) && node->child[2])
778 check_for_crossed_subnodes(node->child[0], limit, ops);
780 if ((direction & QUADTREE_DOWNRIGHT) && node->child[3])
781 check_for_crossed_subnodes(node->child[0], limit, ops);
783 if (direction & QUADTREE_SELF) {
784 struct quadtree *parent;
786 parent = quadtree_del(node, ops);
787 quadtree_add(parent, node, ops);
791 struct quadtree *quadtree_move(struct quadtree *node, struct vector new_pos,
792 struct quadtree_ops *ops)
794 struct quadtree *parent, *tree_parent;
797 /* Check if we have crossed any of the parents */
798 parent = node->parent;
800 if (node->pos.x < parent->pos.x && new_pos.x > parent->pos.x)
802 if (node->pos.x > parent->pos.x && new_pos.x < parent->pos.x)
804 if (node->pos.y < parent->pos.y && new_pos.y > parent->pos.y)
806 if (node->pos.y > parent->pos.y && new_pos.y < parent->pos.y)
810 parent = parent->parent;
815 * If the node has crossed the boundaries, remove it
816 * from the tree and add it again to it. It is then
817 * guaranteed to be in the correct position of the
820 tree_parent = quadtree_del(node, ops);
822 quadtree_add(tree_parent, node, ops);
826 /* Move the node into its new location */
828 recalculate_parent_area_stats(node);
830 if (node->children) {
832 * Now, search the subtree for any children that are
833 * located in wrong place and move them into correct
834 * place within the tree.
836 struct vector limit[2];
838 limit[0] = node->pos;
840 check_for_crossed_subnodes(node, limit, ops);
843 return quadtree_find_parent(node);
847 static int _walk_tree(struct quadtree *head, const struct quadtree_iterator *it)
849 int direction, count = 0;
851 direction = it->direction(head, (struct quadtree_iterator *)it);
853 if ((direction & QUADTREE_UPLEFT) && head->child[0])
854 count += _walk_tree(head->child[0], it);
856 if ((direction & QUADTREE_UPRIGHT) && head->child[1])
857 count += _walk_tree(head->child[1], it);
859 if ((direction & QUADTREE_DOWNLEFT) && head->child[2])
860 count += _walk_tree(head->child[2], it);
862 if ((direction & QUADTREE_DOWNRIGHT) && head->child[3])
863 count += _walk_tree(head->child[3], it);
865 if ((direction & QUADTREE_SELF) && it->callback) {
866 it->callback(head, (struct quadtree_iterator *)it);
873 int walk_quadtree(const struct quadtree_iterator *it)
875 return _walk_tree(it->head, it);