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 quadrants_to_search(struct quadtree *node, struct vector *corner)
298 int direction = 0, i;
299 int up = 0, left = 0, right = 0, down = 0;
301 for (i = 0; i < 2; i++) {
302 if (corner[i].x <= node->pos.x)
304 else if (corner[i].x >= node->pos.x)
306 if (corner[i].y <= node->pos.y)
308 else if (corner[i].y >= node->pos.y)
313 direction |= QUADTREE_UPLEFT;
315 direction |= QUADTREE_UPRIGHT;
317 direction |= QUADTREE_DOWNLEFT;
319 direction |= QUADTREE_DOWNRIGHT;
324 static struct quadtree *quadtree_find_nearest(struct quadtree *tree,
326 struct vector *corner)
329 struct quadtree *nearest, *node;
330 double distance = 0, dist;
333 if (!is_within(pos, corner)) {
335 printf("No nearest to be found from (%f %f) (%f %f) "
337 corner[0].x, corner[0].y,
338 corner[1].x, corner[1].y,
345 if (is_within(&tree->pos, corner)) {
346 vector_sub(pos, &tree->pos, &tmp);
347 distance = vector_abs(&tmp);
353 directions = quadrants_to_search(tree, corner);
355 for (i = 0; i < 4; i++) {
360 if (!(directions & (1 << i)))
363 node = quadtree_find_nearest(tree->child[i], pos, corner);
368 vector_sub(pos, &node->pos, &tmp);
369 dist = vector_abs(&tmp);
371 if (!nearest || dist < distance) {
378 if (nearest && !is_within(&nearest->pos, corner)) {
380 printf("Node %p (%f %f) is not within "
381 "search window (%f %f) (%f %f)\n",
382 nearest, nearest->pos.x, nearest->pos.y,
383 corner[0].x, corner[0].y,
384 corner[1].x, corner[1].y);
391 static struct quadtree *quadtree_find_nearest_noparent(struct quadtree *tree,
393 struct vector *corner)
395 struct quadtree *nearest;
397 struct quadtree *node;
398 double dist = 0, dist2;
401 nearest = quadtree_find_nearest(tree, pos, corner);
407 printf("Avoiding parent or NULL node %p\n", nearest);
410 * oops, we don't want to pick the parent node, let's choose
414 for (i = 0; i < 4; i++) {
419 nearest = quadtree_find_nearest(tree->child[i], pos,
425 vector_sub(pos, &nearest->pos, &sub);
426 dist = vector_abs(&sub);
429 node = quadtree_find_nearest(tree->child[i],
435 vector_sub(pos, &node->pos, &sub);
436 dist2 = vector_abs(&sub);
448 static void get_middle_point(struct vector *corner, struct vector *middle)
450 middle->x = (corner[0].x + corner[1].x) / (double)2;
451 middle->y = (corner[0].y + corner[1].y) / (double)2;
454 static int quadtree_split_by_node(struct quadtree *node,
455 struct vector *corner, int dir)
457 if (!is_within(&node->pos, corner)) {
459 printf("Not within search rectangle\n");
464 case QUADTREE_UPLEFT:
465 corner[0] = node->pos;
467 case QUADTREE_UPRIGHT:
468 corner[0].y = node->pos.y;
469 corner[1].x = node->pos.x;
471 case QUADTREE_DOWNRIGHT:
472 corner[1] = node->pos;
474 case QUADTREE_DOWNLEFT:
475 corner[0].x = node->pos.x;
476 corner[1].y = node->pos.y;
483 printf("Search rectangle is now (%f %f) (%f %f), (%f %f)\n",
484 corner[0].x, corner[0].y,
485 corner[1].x, corner[1].y,
486 node->pos.x, node->pos.y);
488 if ((corner[0].x < corner[1].x) ||
489 (corner[0].y < corner[1].y))
496 * Quickly detach a node from a tree. Move all child nodes under
499 static int _quadtree_del(struct quadtree *node, struct quadtree *parent)
504 /* Detach from the tree */
506 for (i = 0; i < 4; i++) {
507 if (node->parent->child[i] == node) {
508 node->parent->child[i] = 0;
517 for (i = 0; i < 4; i++) {
522 _quadtree_del(n, parent);
523 _quadtree_add(parent, n);
530 * Move everything under @tree node to @parent node, everything
531 * else except the @tree node itself
533 static int optimally_move_tree(struct quadtree *tree, struct quadtree *parent,
534 struct vector *corner_orig,
535 struct quadtree_ops *ops)
537 struct vector corner[2], mid;
538 struct quadtree *t, *tmp;
541 get_middle_point(corner_orig, &mid);
542 t = quadtree_find_nearest_noparent(tree, &mid, corner_orig);
546 printf("Cannot find nearest node\n");
552 * Now we have the t node which contains the object of the
553 * spatial middle coordinates of the tree.
557 printf("Relocating node %p (%f %f) under parent %p\n", t,
558 t->pos.x, t->pos.y, parent);
559 printf("There are %ld child nodes left\n", tree->children);
562 _quadtree_del(t, tree);
563 quadtree_add(parent, t, ops);
571 * Now split the search rectangle in quadtres and do the same
572 * with all of the quarters.
575 corner[0] = corner_orig[0];
576 corner[1] = corner_orig[1];
577 if (quadtree_split_by_node(t, corner, QUADTREE_UPLEFT))
578 moved += optimally_move_tree(tree, parent, corner, ops);
580 corner[0] = corner_orig[0];
581 corner[1] = corner_orig[1];
582 if (quadtree_split_by_node(t, corner, QUADTREE_UPRIGHT))
583 moved += optimally_move_tree(tree, parent, corner, ops);
585 corner[0] = corner_orig[0];
586 corner[1] = corner_orig[1];
587 if (quadtree_split_by_node(t, corner, QUADTREE_DOWNLEFT))
588 moved += optimally_move_tree(tree, parent, corner, ops);
590 corner[0] = corner_orig[0];
591 corner[1] = corner_orig[1];
592 if (quadtree_split_by_node(t, corner, QUADTREE_DOWNRIGHT))
593 moved += optimally_move_tree(tree, parent, corner, ops);
595 get_middle_point(corner_orig, &mid);
596 tmp = quadtree_find_nearest(tree, &mid, corner_orig);
597 if (tmp && tmp != tree)
602 printf("Now moved %d nodes, %ld left\n", moved, tree->children);
608 * quadtree_del - Detach a node from the tree
610 * Return value: The new root node of the tree. If we are detaching
611 * anything but the root node of the entire tree, the returned root
612 * value will be the original root of the tree.
614 struct quadtree *quadtree_del(struct quadtree *node,
615 struct quadtree_ops *ops)
617 struct quadtree *parent = NULL;
618 struct vector corner[2];
619 int i, children = node->children, moved;
624 printf("Deleting node %p under parent %p\n",
626 printf("Relocating %ld children\n", node->children);
632 * We are deleting the root node. This means we have
633 * to select a new root node and reconstruct the
634 * entire tree under it again.
637 printf("Deleting root node\n");
640 for (i = 0; i < 4; i++) {
644 parent = node->child[i];
645 _quadtree_del(parent, node);
647 quadtree_recalculate_parent_stats(parent, ops);
652 * The node has a parent. Detach the node from it and
653 * relocate the children.
656 for (i = 0; i < 4; i++) {
657 if (node->parent->child[i] == node) {
658 node->parent->child[i] = 0;
665 parent = node->parent;
668 * The sub branch is now detached from the main
669 * tree. Fix the stats.
671 quadtree_recalculate_parent_stats(node->parent, ops);
674 validate_tree(parent);
679 * Now we are ready to prepare for relocating the nodes under
683 corner[0] = node->corner[1];
684 corner[1] = node->corner[0];
685 moved = optimally_move_tree(node, parent, corner, ops);
688 if (moved != children) {
689 printf("Got %d children but %d were moved\n",
691 printf("nearest children left:\n");
692 for (i = 0 ; i < 4; i++)
694 printf(" node %d %p, (%f %f)\n",
696 node->child[i]->pos.x,
697 node->child[i]->pos.y);
701 printf("Delete done, returning parent %p\n", parent);
706 validate_tree(parent);
707 return quadtree_find_parent(parent);
710 static void check_for_crossed_subnodes(struct quadtree *node,
711 struct vector *limit, struct quadtree_ops *ops)
713 int direction = 0, i;
714 int up = 0, left = 0, right = 0, down = 0;
716 for (i = 0; i < 2; i++) {
717 if (limit[i].x < node->pos.x)
721 if (limit[i].y < node->pos.y)
728 direction |= QUADTREE_UPLEFT;
730 direction |= QUADTREE_UPRIGHT;
732 direction |= QUADTREE_DOWNLEFT;
734 direction |= QUADTREE_DOWNRIGHT;
735 if ((left && right) || (up && down))
736 direction |= QUADTREE_SELF;
738 if ((direction & QUADTREE_UPLEFT) && node->child[0])
739 check_for_crossed_subnodes(node->child[0], limit, ops);
741 if ((direction & QUADTREE_UPRIGHT) && node->child[1])
742 check_for_crossed_subnodes(node->child[0], limit, ops);
744 if ((direction & QUADTREE_DOWNLEFT) && node->child[2])
745 check_for_crossed_subnodes(node->child[0], limit, ops);
747 if ((direction & QUADTREE_DOWNRIGHT) && node->child[3])
748 check_for_crossed_subnodes(node->child[0], limit, ops);
750 if (direction & QUADTREE_SELF) {
751 struct quadtree *parent;
753 parent = quadtree_del(node, ops);
754 quadtree_add(parent, node, ops);
758 struct quadtree *quadtree_move(struct quadtree *node, struct vector new_pos,
759 struct quadtree_ops *ops)
761 struct quadtree *parent, *tree_parent;
764 /* Check if we have crossed any of the parents */
765 parent = node->parent;
767 if (node->pos.x < parent->pos.x && new_pos.x > parent->pos.x)
769 if (node->pos.x > parent->pos.x && new_pos.x < parent->pos.x)
771 if (node->pos.y < parent->pos.y && new_pos.y > parent->pos.y)
773 if (node->pos.y > parent->pos.y && new_pos.y < parent->pos.y)
777 parent = parent->parent;
782 * If the node has crossed the boundaries, remove it
783 * from the tree and add it again to it. It is then
784 * guaranteed to be in the correct position of the
787 tree_parent = quadtree_del(node, ops);
789 quadtree_add(tree_parent, node, ops);
790 quadtree_recalculate_parent_stats(node, ops);
794 /* Move the node into its new location */
799 * Now, search the subtree for any children that are
800 * located in wrong place and move them into correct
801 * place within the tree.
803 struct vector limit[2];
805 limit[0] = node->pos;
807 check_for_crossed_subnodes(node, limit, ops);
810 quadtree_recalculate_parent_stats(node, ops);
811 return quadtree_find_parent(node);
815 static int _walk_tree(struct quadtree *head, const struct quadtree_iterator *it)
817 int direction, count = 0;
819 direction = it->direction(head, (struct quadtree_iterator *)it);
821 if ((direction & QUADTREE_UPLEFT) && head->child[0])
822 count += _walk_tree(head->child[0], it);
824 if ((direction & QUADTREE_UPRIGHT) && head->child[1])
825 count += _walk_tree(head->child[1], it);
827 if ((direction & QUADTREE_DOWNLEFT) && head->child[2])
828 count += _walk_tree(head->child[2], it);
830 if ((direction & QUADTREE_DOWNRIGHT) && head->child[3])
831 count += _walk_tree(head->child[3], it);
833 if ((direction & QUADTREE_SELF) && it->callback) {
834 it->callback(head, (struct quadtree_iterator *)it);
841 int walk_quadtree(const struct quadtree_iterator *it)
843 return _walk_tree(it->head, it);