added unit tests

Author: nwlandry

docs/source/api/algorithms/xgi.algorithms.properties.rst

@@ -11,6 +11,7 @@ xgi.algorithms.properties
    .. autofunction:: degree_histogram
    .. autofunction:: density
    .. autofunction:: edge_neighborhood
+   .. autofunction:: equal
    .. autofunction:: incidence_density
    .. autofunction:: is_possible_order
    .. autofunction:: is_uniform

tests/algorithms/test_properties.py

@@ -4,6 +4,52 @@
 from xgi.exception import IDNotFound, XGIError
 
 
+def test_equality(edgelist1, edgelist2, diedgelist1, diedgelist2):
+    # hypergraph
+    H1 = xgi.Hypergraph(edgelist1)
+    H2 = xgi.Hypergraph(edgelist1)
+    H3 = xgi.Hypergraph(edgelist2)
+
+    assert xgi.equal(H1, H2)
+    assert not xgi.equal(H2, H3)
+
+    H1["test"] = "this should break equality"
+    assert not xgi.equal(H1, H2)
+
+    assert xgi.equal(H1, H2, compare_attrs=False)
+
+    el1 = {0: {1, 2, 3}, 1: {1, 2}}
+    el2 = {1: {1, 2, 3}, 2: {1, 2}}
+
+    H1 = xgi.Hypergraph(el1)
+    H2 = xgi.Hypergraph(el2)
+
+    assert not xgi.equal(H1, H2, compare_ids=True)
+    assert xgi.equal(H1, H2, compare_ids=False)
+
+    # dihypergraphs
+    H1 = xgi.DiHypergraph(diedgelist1)
+    H2 = xgi.DiHypergraph(diedgelist1)
+    H3 = xgi.DiHypergraph(diedgelist2)
+
+    assert xgi.equal(H1, H2)
+    assert not xgi.equal(H2, H3)
+
+    H1["test"] = "this should break equality"
+    assert not xgi.equal(H1, H2)
+
+    assert xgi.equal(H1, H2, compare_attrs=False)
+
+    del1 = {0: ({1, 2, 3}, {4}), 1: ({5, 6}, {6, 7, 8})}
+    del2 = {1: ({1, 2, 3}, {4}), 2: ({5, 6}, {6, 7, 8})}
+
+    H1 = xgi.DiHypergraph(del1)
+    H2 = xgi.DiHypergraph(del2)
+
+    assert not xgi.equal(H1, H2, compare_ids=True)
+    assert xgi.equal(H1, H2, compare_ids=False)
+
+
 def test_num_edges_order(edgelist2):
     H = xgi.Hypergraph(edgelist2)
 

tests/core/test_dihypergraph.py

@@ -44,6 +44,18 @@ def test_contains(diedgelist1):
     assert [0] not in H
 
 
+def test_equals(diedgelist1, diedgelist2):
+    H1 = xgi.DiHypergraph(diedgelist1)
+    H2 = xgi.DiHypergraph(diedgelist1)
+    H3 = xgi.DiHypergraph(diedgelist2)
+
+    assert H1 == H2
+    assert H2 != H3
+
+    H1["test"] = "this should break equality"
+    assert H1 != H2
+
+
 def test_string():
     H1 = xgi.DiHypergraph()
     assert str(H1) == "Unnamed DiHypergraph with 0 nodes and 0 hyperedges"

tests/core/test_hypergraph.py

@@ -85,6 +85,18 @@ def test_lshift(edgelist1, edgelist2, hyperwithattrs):
     assert H.edges.members(7) == {1, 2, 3}
 
 
+def test_equals(edgelist1, edgelist2):
+    H1 = xgi.Hypergraph(edgelist1)
+    H2 = xgi.Hypergraph(edgelist1)
+    H3 = xgi.Hypergraph(edgelist2)
+
+    assert H1 == H2
+    assert H2 != H3
+
+    H1["test"] = "this should break equality"
+    assert H1 != H2
+
+
 def test_string():
     H1 = xgi.Hypergraph()
     assert str(H1) == "Unnamed Hypergraph with 0 nodes and 0 hyperedges"

xgi/algorithms/properties.py

@@ -33,19 +33,22 @@ def equal(H1, H2, compare_ids=True, compare_attrs=True):
         edges2_with_counts = defaultdict(lambda: 0)
         for e in H2.edges.members():
             edges2_with_counts[frozenset(e)] += 1
-
+        print(dict(edges1_with_counts), dict(edges2_with_counts))
         if edges1_with_counts != edges2_with_counts:
+            print("hi")
             return False
 
     if compare_attrs:
-        if H1._hypergraph != H2._hypergraph:
+        if H1._net_attr != H2._net_attr:
             return False
 
-        if H1._node_attrs != H2._node_attrs:
+        if H1._node_attr != H2._node_attr:
             return False
 
-        if H1._edge_attrs != H2._edge_attrs:
-            return False
+        # there's no sense in comparing edge attrs if we're not matching on IDs
+        if compare_ids:
+            if H1._edge_attr != H2._edge_attr:
+                return False
 
     return True