new add method (#203)

xgi-org · Oct 31, 2022 · 93320f5 · 93320f5
1 parent 74950ff
commit 93320f5
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 2 deletions.
diff --git a/tests/classes/test_hypergraph.py b/tests/classes/test_hypergraph.py
@@ -57,6 +57,22 @@ def test_contains(edgelist1):
     assert [1, 2, 3] not in H
 
 
+def test_lshift(edgelist1, edgelist2, hyperwithattrs):
+    H1 = xgi.Hypergraph(edgelist1)
+    H2 = xgi.Hypergraph(edgelist2)
+    H3 = hyperwithattrs
+    H = H1 << H2
+    assert set(H.nodes) == {1, 2, 3, 4, 5, 6, 7, 8}
+    assert H.num_edges == 7
+    assert H.edges.members(0) == {1, 2, 3}
+
+    H = H1 << H2 << H3
+    assert set(H.nodes) == {1, 2, 3, 4, 5, 6, 7, 8}
+    assert H.num_edges == 10
+    assert H.nodes[1] == {"color": "red", "name": "horse"}
+    assert H.edges.members(7) == {1, 2, 3}
+
+
 def test_string():
     H1 = xgi.Hypergraph()
     assert str(H1) == "Unnamed Hypergraph with 0 nodes and 0 hyperedges"

diff --git a/xgi/classes/hypergraph.py b/xgi/classes/hypergraph.py
@@ -204,6 +204,55 @@ def func(node=None, *args, **kwargs):
 
         return func
 
+    def __lshift__(self, H2):
+        """Adds the edges of a hypergraph to the current hypergraph
+        and updates the attributes.
+
+        The node/edge attributes of the new hypergraph take precedence.
+
+        Relabels all the edge IDs to preserve all the edges but
+        keeps the node labels the same.
+
+        Parameters
+        ----------
+        H2 : Hypergraph
+            The hypergraph to update with.
+
+        Returns
+        -------
+        Hypergraph
+            The updated hypergraph
+
+        Notes
+        -----
+        Addition is not quite commutative; the attributes of nodes and edges
+        may be overwritten depending on whether they are first or second
+        to be added. In addition, the edge IDs are assigned based on the order
+        in which the edges are added, but does not functionally change the
+        structure of the hypergraph.
+
+        Examples
+        --------
+
+        >>> import xgi
+        >>> H1 = xgi.Hypergraph([[1, 2], [2, 3]])
+        >>> H2 = xgi.Hypergraph([[1, 3, 4]])
+        >>> H = H1 << H2
+        >>> H.edges.members()
+        [{1, 2}, {2, 3}, {1, 3, 4}]
+        """
+        tempH = Hypergraph()
+        tempH.add_edges_from(zip(self._edge.values(), self._edge_attr.values()))
+        tempH.add_nodes_from(zip(self._node.keys(), self._node_attr.values()))
+
+        tempH.add_edges_from(zip(H2._edge.values(), H2._edge_attr.values()))
+        tempH.add_nodes_from(zip(H2._node.keys(), H2._node_attr.values()))
+
+        tempH._hypergraph = deepcopy(self._hypergraph)
+        tempH._hypergraph.update(deepcopy(H2._hypergraph))
+
+        return tempH
+
     @property
     def nodes(self):
         """A :class:`NodeView` of this network."""

diff --git a/xgi/generators/classic.py b/xgi/generators/classic.py
@@ -13,9 +13,8 @@
 import numpy as np
 
 from ..classes import SimplicialComplex
-from ..utils import py_random_state
-
 from ..exception import XGIError
+from ..utils import py_random_state
 
 __all__ = [
     "empty_hypergraph",