src/org/xwt/util/BalancedTree.java

   1 // Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
   2 package org.xwt.util;
   3
   4 // FEATURE: private void intersection() { }
   5 // FEATURE: private void union() { }
   6 // FEATURE: private void subset() { }
   7 // FEATURE: grow if we run out of slots
   8 // FEATURE: finalizer
   9
  10 /** a weight-balanced tree with fake leaves */
  11 public class BalancedTree {
  12
  13
  14     // Instance Variables ///////////////////////////////////////////////////////////////////
  15
  16     private int root = 0;                         ///< the slot of the root element
  17
  18     private int cached_index = -1;
  19     private int cached_slot = -1;
  20
  21     // Public API //////////////////////////////////////////////////////////////////////////
  22
  23     /** the number of elements in the tree */
  24     public final int treeSize() { return root == 0 ? 0 : size[root]; }
  25
  26     /** clamps index to [0..treeSize()] and inserts object o *before* the specified index */
  27     public final void insertNode(int index, Object o) {
  28         cached_slot = cached_index = -1;
  29         if (index < 0) index = 0;
  30         if (index > treeSize()) index = treeSize();
  31         int arg = allocateSlot(o);
  32         if (root != 0) { insert(index, arg, root, 0, false, false); return; }
  33         root = arg;
  34         left[arg] = 0;
  35         right[arg] = 0;
  36         size[root] = 1;
  37     }
  38
  39     /** clamps index to [0..treeSize()-1] and replaces the object at that index with object o */
  40     public final void replaceNode(int index, Object o) {
  41         cached_slot = cached_index = -1;
  42         if (index < 0) index = 0;
  43         if (index > treeSize()) index = treeSize() - 1;
  44         int arg = allocateSlot(o);
  45         if (root != 0) { insert(index, arg, root, 0, true, false); return; }
  46         root = arg;
  47         left[arg] = 0;
  48         right[arg] = 0;
  49     }
  50
  51     /** returns the index of o; runs in O((log n)^2) time unless cache hit */
  52     public final int indexNode(Object o) {
  53         if (cached_slot != -1 && objects[cached_slot] == o) return cached_index;
  54
  55         int slot = getSlot(o, o.hashCode() ^ this.hashCode());
  56         int parent = -1 * left[leftmost(slot)];
  57         if (parent == 0) return size(left[slot]);             // we are on the far left edge
  58
  59         // all nodes after parent and before us are in our left subtree
  60         return size(left[slot]) + indexNode(objects[parent]) + 1;
  61     }
  62
  63     /** returns the object at index; runs in O(log n) time unless cache hit */
  64     public final Object getNode(int index) {
  65         if (index == cached_index) return objects[cached_slot];
  66
  67         if (cached_index != -1) {
  68             int distance = Math.abs(index - cached_index);
  69             // if the in-order distance between the cached node and the
  70             // target node is less than log(n), it's probably faster to
  71             // search directly.
  72             if ((distance < 16) && ((2 << distance) < treeSize())) {
  73                 while(cached_index > index) { cached_slot = prev(cached_slot); cached_index--; }
  74                 while(cached_index < index) { cached_slot = next(cached_slot); cached_index++; }
  75                 return objects[cached_slot];
  76             }
  77         }
  78
  79         cached_index = index;
  80         cached_slot = get(index, root);
  81         return objects[cached_slot];
  82     }
  83
  84     /** deletes the object at index, returning the deleted object */
  85     public final Object deleteNode(int index) {
  86         cached_slot = cached_index = -1;
  87         int del = delete(index, root, 0);
  88         left[del] = right[del] = size[del] = 0;
  89         Object ret = objects[del];
  90         objects[del] = null;
  91         return ret;
  92     }
  93
  94
  95     // Node Data /////////////////////////////////////////////////////////////////////////
  96
  97     private final static int NUM_SLOTS = 64 * 1024;
  98
  99     /**
 100      * Every object inserted into *any* tree gets a "slot" in this
 101      * array.  The slot is determined by hashcode modulo the length of
 102      * the array, with quadradic probing to resolve collisions.  NOTE
 103      * that the "slot" of a node is NOT the same as its index.
 104      * Furthermore, if an object is inserted into multiple trees, that
 105      * object will have multiple slots.
 106      */
 107     private static Object[] objects = new Object[NUM_SLOTS];
 108
 109     /// These two arrays hold the left and right children of each
 110     /// slot; in other words, left[x] is the *slot* of the left child
 111     /// of the node in slot x.
 112     ///
 113     /// If x has no left child, then left[x] is -1 multiplied by the
 114     /// slot of the node that precedes x; if x is the first node, then
 115     /// left[x] is 0.  The right[] array works the same way.
 116     ///
 117     private static int[] left = new int[NUM_SLOTS];
 118     private static int[] right = new int[NUM_SLOTS];
 119
 120     ///< the number of descendants of this node *including the node itself*
 121     private static int[] size = new int[NUM_SLOTS];
 122
 123
 124     // Slot Management //////////////////////////////////////////////////////////////////////
 125
 126     /** returns the slot holding object o; use null to allocate a new slot */
 127     private int getSlot(Object o, int hash) {
 128         // FIXME: check for full table
 129         int dest = Math.abs(hash) % objects.length;
 130         int odest = dest;
 131         boolean plus = true;
 132         int tries = 1;
 133         while (objects[dest] != o) {
 134             if (dest == 0) dest++;
 135             dest = Math.abs((odest + (plus ? 1 : -1) * tries * tries) % objects.length);
 136             if (plus) tries++;
 137             plus = !plus;
 138         }
 139         return dest;
 140     }
 141
 142     /** allocates a new slot */
 143     private int allocateSlot(Object o) {
 144         // we XOR with our own hashcode so that we don't get tons of
 145         // collisions when a single Object is inserted into multiple
 146         // trees
 147         int slot = getSlot(null, o.hashCode() ^ this.hashCode());
 148         objects[slot] = o;
 149         return slot;
 150     }
 151
 152
 153
 154     // Helpers /////////////////////////////////////////////////////////////////////////
 155
 156     private final int leftmost(int slot) { return left[slot] <= 0 ? slot : leftmost(left[slot]); }
 157     private final int rightmost(int slot) { return right[slot] <= 0 ? slot : rightmost(right[slot]); }
 158     private final int next(int slot) { return right[slot] <= 0 ? -1 * right[slot] : leftmost(right[slot]); }
 159     private final int prev(int slot) { return left[slot] <= 0 ? -1 * left[slot] : rightmost(left[slot]); }
 160     private final int size(int slot) { return slot <= 0 ? 0 : size[slot]; }
 161
 162
 163     // Rotation and Balancing /////////////////////////////////////////////////////////////
 164
 165     //    parent             parent
 166     //      |                  |
 167     //      b                  d
 168     //     / \                / \
 169     //    a   d    < == >    b   e
 170     //       / \            / \
 171     //      c   e          a   c
 172     // FIXME might be doing too much work here
 173     private void rotate(boolean toTheLeft, int b, int parent) {
 174         int[] left = toTheLeft ? BalancedTree.left : BalancedTree.right;
 175         int[] right = toTheLeft ? BalancedTree.right : BalancedTree.left;
 176         int d = right[b];
 177         int c = left[d];
 178         if (d <= 0) throw new Error("rotation error");
 179         left[d] = b;
 180         right[b] = c;
 181         if (parent == 0)              root = d;
 182         else if (left[parent] == b)   left[parent] = d;
 183         else if (right[parent] == b)  right[parent] = d;
 184         else throw new Error("rotate called with invalid parent");
 185         balance(b, d);
 186         balance(d, parent);
 187     }
 188
 189     private void balance(int slot, int parent) {
 190         if (slot <= 0) return;
 191         size[slot] = 1 + size(left[slot]) + size(right[slot]);
 192         if (size(left[slot]) - 1 > 2 * size(right[slot])) rotate(false, slot, parent);
 193         else if (size(left[slot]) * 2 < size(right[slot]) - 1) rotate(true, slot, parent);
 194     }
 195
 196
 197
 198     // Insert /////////////////////////////////////////////////////////////////////////
 199
 200     private void insert(int index, int arg, int slot, int parent, boolean replace, boolean wentLeft) {
 201         int diff = slot <= 0 ? 0 : index - size(left[slot]);
 202         if (slot > 0 && diff != 0) {
 203             if (diff < 0) insert(index, arg, left[slot], slot, replace, true);
 204             else insert(index - size(left[slot]) - 1, arg, right[slot], slot, replace, false);
 205             balance(slot, parent);
 206             return;
 207         }
 208
 209         if (size[arg] != 0) throw new Error("double insertion");
 210
 211         // we become the child of a former leaf
 212         if (slot <= 0) {
 213             int[] left = wentLeft ? BalancedTree.left : BalancedTree.right;
 214             int[] right = wentLeft ? BalancedTree.right : BalancedTree.left;
 215             left[arg] = slot;
 216             left[parent] = arg;
 217             right[arg] = -1 * parent;
 218             balance(arg, parent);
 219
 220         // we take the place of a preexisting node
 221         } else {
 222             left[arg] = left[slot];   // steal slot's left subtree
 223             left[slot] = -1 * arg;
 224             right[arg] = slot;        // make slot our right subtree
 225             if (slot == root) {
 226                 root = arg;
 227                 balance(slot, arg);
 228             } else {
 229                 (left[parent] == slot ? left : right)[parent] = arg;
 230                 balance(slot, arg);
 231                 balance(arg, parent);
 232             }
 233         }
 234     }
 235
 236
 237     // Retrieval //////////////////////////////////////////////////////////////////////
 238
 239     private int get(int index, int slot) {
 240         int diff = index - size(left[slot]);
 241         if (diff > 0) return get(diff - 1, right[slot]);
 242         else if (diff < 0) return get(index, left[slot]);
 243         else return slot;
 244     }
 245
 246
 247     // Deletion //////////////////////////////////////////////////////////////////////
 248
 249     private int delete(int index, int slot, int parent) {
 250         int diff = index - size(left[slot]);
 251         if (diff < 0) {
 252             int ret = delete(index, left[slot], slot);
 253             balance(slot, parent);
 254             return ret;
 255
 256         } else if (diff > 0) {
 257             int ret = delete(diff - 1, right[slot], slot);
 258             balance(slot, parent);
 259             return ret;
 260
 261         // we found the node to delete
 262         } else {
 263
 264             // fast path: it has no children
 265             if (left[slot] <= 0 && right[slot] <= 0) {
 266                 if (parent == 0) root = 0;
 267                 else {
 268                     int[] side = left[parent] == slot ? left : right;
 269                     side[parent] = side[slot];      // fix parent's pointer
 270                 }
 271
 272             // fast path: it has no left child, so we replace it with its right child
 273             } else if (left[slot] <= 0) {
 274                 if (parent == 0) root = right[slot];
 275                 else (left[parent] == slot ? left : right)[parent] = right[slot];     // fix parent's pointer
 276                 if (right[slot] > 0) left[leftmost(right[slot])] = left[slot];        // fix our successor-leaf's fake right ptr
 277                 balance(right[slot], parent);
 278
 279             // fast path; it has no right child, so we replace it with its left child
 280             } else if (right[slot] <= 0) {
 281                 if (parent == 0) root = left[slot];
 282                 else (left[parent] == slot ? left : right)[parent] = left[slot];      // fix parent's pointer
 283                 if (left[slot] > 0) right[rightmost(left[slot])] = right[slot];       // fix our successor-leaf's fake right ptr
 284                 balance(left[slot], parent);
 285
 286             // node to be deleted has two children, so we replace it with its left child's rightmost descendant
 287             } else {
 288                 int left_childs_rightmost = delete(size(left[slot]) - 1, left[slot], slot);
 289                 left[left_childs_rightmost] = left[slot];
 290                 left[left_childs_rightmost] = right[slot];
 291                 if (parent == 0) root = left_childs_rightmost;
 292                 else (left[parent] == slot ? left : right)[parent] = left_childs_rightmost;     // fix parent's pointer
 293                 balance(left_childs_rightmost, parent);
 294             }
 295
 296             return slot;
 297         }
 298     }
 299
 300 }