[MOD] XQuery: comparison of maps revised (simplified, faster)

ChristianGruen · ChristianGruen · commit c775bd5784ac · 2025-03-04T19:53:13.000+01:00
diff --git a/basex-core/src/main/java/org/basex/query/util/DeepEqualOptions.java b/basex-core/src/main/java/org/basex/query/util/DeepEqualOptions.java
@@ -42,6 +42,9 @@ public final class DeepEqualOptions extends Options {
   /** Option: items-equal. */
   public static final ValueOption ITEMS_EQUAL =
       new ValueOption("items-equal", SeqType.FUNCTION_O);
+  /** Option: map-order. */
+  public static final BooleanOption MAP_ORDER =
+      new BooleanOption("map-order", false);
   /** Option: namespace-prefixes. */
   public static final BooleanOption NAMESPACE_PREFIXES =
       new BooleanOption("namespace-prefixes", false);
diff --git a/basex-core/src/main/java/org/basex/query/value/map/TrieBranch.java b/basex-core/src/main/java/org/basex/query/value/map/TrieBranch.java
@@ -1,7 +1,6 @@
 package org.basex.query.value.map;
 
 import org.basex.query.*;
-import org.basex.query.util.*;
 import org.basex.query.value.*;
 import org.basex.query.value.item.*;
 import org.basex.util.*;
@@ -83,22 +82,6 @@ Value get(final int hs, final Item ky, final int lv) throws QueryException {
     return sub == null ? null : sub.get(hs, ky, lv + 1);
   }
 
-  @Override
-  boolean equal(final TrieNode node, final DeepEqual deep) throws QueryException {
-    if(!(node instanceof TrieBranch)) return false;
-
-    // check bit usage first
-    final TrieBranch ob = (TrieBranch) node;
-    if(used != ob.used) return false;
-    // recursively compare children
-    if(deep != null && deep.qc != null) deep.qc.checkStop();
-    for(int k = 0; k < KIDS; k++) {
-      if(kids[k] != null && !kids[k].equal(ob.kids[k], deep)) return false;
-    }
-    // everything OK
-    return true;
-  }
-
   /** End strings. */
   private static final String[] ENDS = { "|-- ", "|   ", "`-- ", "    " };
 
diff --git a/basex-core/src/main/java/org/basex/query/value/map/TrieEmpty.java b/basex-core/src/main/java/org/basex/query/value/map/TrieEmpty.java
@@ -1,6 +1,5 @@
 package org.basex.query.value.map;
 
-import org.basex.query.util.*;
 import org.basex.query.value.*;
 import org.basex.query.value.item.*;
 import org.basex.util.*;
@@ -37,11 +36,6 @@ Value get(final int hs, final Item ky, final int lv) {
     return null;
   }
 
-  @Override
-  boolean equal(final TrieNode node, final DeepEqual deep) {
-    return this == node;
-  }
-
   @Override
   void add(final TokenBuilder tb, final String indent) {
     tb.add("{}");
diff --git a/basex-core/src/main/java/org/basex/query/value/map/TrieLeaf.java b/basex-core/src/main/java/org/basex/query/value/map/TrieLeaf.java
@@ -1,7 +1,6 @@
 package org.basex.query.value.map;
 
 import org.basex.query.*;
-import org.basex.query.util.*;
 import org.basex.query.value.*;
 import org.basex.query.value.item.*;
 import org.basex.util.*;
@@ -66,16 +65,6 @@ Value get(final int hs, final Item ky, final int lv) throws QueryException {
     return hs == hash && key.atomicEqual(ky) ? value : null;
   }
 
-  @Override
-  boolean equal(final TrieNode node, final DeepEqual deep) throws QueryException {
-    if(node instanceof TrieLeaf) {
-      final TrieLeaf leaf = (TrieLeaf) node;
-      return deep != null ? key.atomicEqual(leaf.key) && deep.equal(value, leaf.value) :
-        key.equals(leaf.key) && value.equals(leaf.value);
-    }
-    return false;
-  }
-
   @Override
   void add(final TokenBuilder tb, final String indent) {
     tb.add(indent).add("`-- ").add(key).add(" => ").add(value).add('\n');
diff --git a/basex-core/src/main/java/org/basex/query/value/map/TrieList.java b/basex-core/src/main/java/org/basex/query/value/map/TrieList.java
@@ -1,7 +1,6 @@
 package org.basex.query.value.map;
 
 import org.basex.query.*;
-import org.basex.query.util.*;
 import org.basex.query.value.*;
 import org.basex.query.value.item.*;
 import org.basex.util.*;
@@ -15,7 +14,6 @@
 final class TrieList extends TrieNode {
   /** Common hash value of all contained values. */
   final int hash;
-
   /** List of keys of this collision list. */
   final Item[] keys;
   /** List of values of this collision list. */
@@ -109,34 +107,6 @@ Value get(final int hs, final Item ky, final int lv) throws QueryException {
     return null;
   }
 
-  @Override
-  boolean equal(final TrieNode node, final DeepEqual deep) throws QueryException {
-    if(!(node instanceof TrieList) || size != node.size) return false;
-
-    // do the evil nested-loop thing
-    final TrieList ol = (TrieList) node;
-    OUTER:
-    for(int i = 0; i < size; i++) {
-      if(deep != null && deep.qc != null) deep.qc.checkStop();
-      final Item key = keys[i];
-      final Value value = values[i];
-      for(int j = 0; j < size; j++) {
-        if(deep != null) {
-          if(!key.atomicEqual(ol.keys[j])) continue;
-          if(!deep.equal(value, ol.values[j])) return false;
-        } else {
-          if(!key.equals(ol.keys[j])) continue;
-          if(!value.equals(ol.values[j])) return false;
-        }
-        continue OUTER;
-      }
-      // all keys of the other list were checked, none matched
-      return false;
-    }
-    // all entries were found
-    return true;
-  }
-
   @Override
   void add(final TokenBuilder tb, final String indent) {
     tb.add(indent).add("`-- Collision (").add(Integer.toHexString(hash)).add("):\n");
diff --git a/basex-core/src/main/java/org/basex/query/value/map/TrieNode.java b/basex-core/src/main/java/org/basex/query/value/map/TrieNode.java
@@ -1,7 +1,6 @@
 package org.basex.query.value.map;
 
 import org.basex.query.*;
-import org.basex.query.util.*;
 import org.basex.query.value.*;
 import org.basex.query.value.item.*;
 import org.basex.util.*;
@@ -98,15 +97,6 @@ static int hashKey(final int hash, final int level) {
     return hash >>> level * BITS & MASK;
   }
 
-  /**
-   * Checks if this node is indistinguishable from the given node.
-   * @param node other node
-   * @param deep comparator
-   * @return result of check
-   * @throws QueryException query exception
-   */
-  abstract boolean equal(TrieNode node, DeepEqual deep) throws QueryException;
-
   /**
    * Recursive {@link #toString()} helper.
    * @param tb token builder
diff --git a/basex-core/src/main/java/org/basex/query/value/map/XQHashMap.java b/basex-core/src/main/java/org/basex/query/value/map/XQHashMap.java
@@ -3,7 +3,6 @@
 import org.basex.query.*;
 import org.basex.query.expr.*;
 import org.basex.query.iter.*;
-import org.basex.query.util.*;
 import org.basex.query.util.hash.*;
 import org.basex.query.value.*;
 import org.basex.query.value.item.*;
@@ -79,23 +78,6 @@ public Value value(final QueryContext qc, final Expr expr) {
     };
   }
 
-  @Override
-  public boolean deepEqual(final XQMap compare, final DeepEqual deep) throws QueryException {
-    final ItemObjectMap<Value> map2 = ((XQHashMap) compare).map;
-    final int is = map.size();
-    for(int i = 1; i <= is; i++) {
-      final Item key = map.key(i), key2 = map2.key(i);
-      final Value value = map.value(i), value2 = map2.value(i);
-      if(deep != null) {
-        // different order: call fallback
-        if(!(key.atomicEqual(key2) && deep.equal(value, value2))) return deepEq(compare, deep);
-      } else {
-        if(!(key.equals(key2) && value.equals(value2))) return false;
-      }
-    }
-    return true;
-  }
-
   /**
    * Transforms the map to an immutable representation.
    * @return map
diff --git a/basex-core/src/main/java/org/basex/query/value/map/XQMap.java b/basex-core/src/main/java/org/basex/query/value/map/XQMap.java
@@ -368,53 +368,58 @@ public final boolean deepEqual(final Item item, final DeepEqual deep) throws Que
     if(!(item instanceof XQMap)) return false;
     final XQMap map = (XQMap) item;
     if(structSize() != map.structSize()) return false;
-    // compare identical map representations first (faster)
-    return getClass() == map.getClass() ? deepEqual(map, deep) : deepEq(map, deep);
+    // compilation: ordered comparison
+    if(deep == null) return deepEqualOrdered(map);
+    // deep equality: always compare ordered first (faster)
+    return deepEqualOrdered(map, deep) ||
+      !deep.options.get(DeepEqualOptions.MAP_ORDER) && deepEqualUnordered(map, deep);
   }
 
   /**
-   * Compares two maps for equality (fallback).
+   * Compares two maps for equality, considering order, at compile time.
    * @param map map to be compared
-   * @param deep comparator (can be {@code null})
    * @return result of check
    * @throws QueryException query exception
    */
-  final boolean deepEq(final XQMap map, final DeepEqual deep) throws QueryException {
-    // compare sorted entries
-    final BasicIter<Item> keys = keys(), keys2 = map.keys();
-    while(true) {
-      final Item key = keys.next(), key2 = keys2.next();
-      if(key == null) return true;
-      final Value value = getInternal(key), value2 = map.getInternal(key2);
-      if(deep != null) {
-        if(!(key.atomicEqual(key2) && deep.equal(value, value2))) break;
-      } else {
-        if(!(key.equals(key2) && value.equals(value2))) break;
-      }
+  private boolean deepEqualOrdered(final XQMap map) throws QueryException {
+    final BasicIter<Item> keys2 = map.keys();
+    for(final Item key : keys()) {
+      final Item k = keys2.next();
+      if(!(key.equals(k) && getInternal(key).equals(map.getInternal(k)))) return false;
     }
-    // compare unsorted entries (worst case)
-    return test((key, value) -> {
-      if(deep != null && deep.qc != null) deep.qc.checkStop();
-      for(final Item key2 : map.keys()) {
-        final Value value2 = map.getInternal(key2);
-        if(deep != null) {
-          if(key.atomicEqual(key2)) return deep.equal(value, value2);
-        } else {
-          if(key.equals(key2)) return value.equals(value2);
-        }
-      }
-      return false;
-    });
+    return true;
+  }
+
+  /**
+   * Compares two maps for equality, considering order.
+   * @param map map to be compared
+   * @param deep comparator
+   * @return result of check
+   * @throws QueryException query exception
+   */
+  private boolean deepEqualOrdered(final XQMap map, final DeepEqual deep)throws QueryException {
+    final BasicIter<Item> keys2 = map.keys();
+    for(final Item key : keys()) {
+      final Item k = keys2.next();
+      if(!(key.atomicEqual(k) && deep.equal(getInternal(key), map.getInternal(k)))) return false;
+    }
+    return true;
   }
 
   /**
-   * Compares two maps for equality.
+   * Compares two maps for equality, ignoring order.
    * @param map map to be compared
    * @param deep comparator
    * @return result of check
    * @throws QueryException query exception
    */
-  public abstract boolean deepEqual(XQMap map, DeepEqual deep) throws QueryException;
+  private boolean deepEqualUnordered(final XQMap map, final DeepEqual deep) throws QueryException {
+    for(final Item key : keys()) {
+      final Value v = map.getInternal(key);
+      if(v == null || !deep.equal(getInternal(key), v)) return false;
+    }
+    return true;
+  }
 
   @Override
   public final void string(final boolean indent, final TokenBuilder tb, final int level,
diff --git a/basex-core/src/main/java/org/basex/query/value/map/XQTrieMap.java b/basex-core/src/main/java/org/basex/query/value/map/XQTrieMap.java
@@ -2,7 +2,6 @@
 
 import org.basex.query.*;
 import org.basex.query.iter.*;
-import org.basex.query.util.*;
 import org.basex.query.value.*;
 import org.basex.query.value.item.*;
 import org.basex.query.value.seq.*;
@@ -79,9 +78,4 @@ public BasicIter<Item> keys() {
     final long size = structSize();
     return size == 0 ? Empty.ITER : size == 1 ? ((TrieLeaf) root).key.iter() : order.keys();
   }
-
-  @Override
-  public boolean deepEqual(final XQMap map, final DeepEqual deep) throws QueryException {
-    return root.equal(((XQTrieMap) map).root, deep);
-  }
 }
