DiHypergraph class (#372)

* Initial commit * update docstrings * moved read-only test * added dihypergraph tutorial * remove unused convert * updated the node and edge stats * style: format with black * added ability to convert from dihypergraphs to hypergraphs * Update Tutorial 8 - Directed Hypergraphs.ipynb * added test for convert * added source and target methods * response 1 to review * added first round of tests * tests for stats * new direportview file for organization. * Update dihypergraph.py * docs: fixed sphinx errors * docs: added warning and updated docs
xgi-org · Jun 5, 2023 · f22c455 · f22c455
1 parent 387647a
commit f22c455
Show file tree

Hide file tree

Showing 45 changed files with 4,487 additions and 90 deletions.
diff --git a/docs/source/api/algorithms.rst b/docs/source/api/algorithms.rst
@@ -10,4 +10,5 @@ algorithms package
    ~xgi.algorithms.assortativity
    ~xgi.algorithms.centrality
    ~xgi.algorithms.clustering
-   ~xgi.algorithms.connected
+   ~xgi.algorithms.connected
+   ~xgi.algorithms.shortest_path
diff --git a/docs/source/api/classes.rst b/docs/source/api/classes.rst
@@ -8,7 +8,9 @@ classes package
    :toctree: classes
 
    ~xgi.classes.hypergraph
+   ~xgi.classes.dihypergraph
    ~xgi.classes.simplicialcomplex
    ~xgi.classes.reportviews
+   ~xgi.classes.direportviews
    ~xgi.classes.hypergraphviews
    ~xgi.classes.function
diff --git a/docs/source/api/classes/xgi.classes.dihypergraph.DiHypergraph.rst b/docs/source/api/classes/xgi.classes.dihypergraph.DiHypergraph.rst
@@ -0,0 +1,35 @@
+xgi.classes.dihypergraph.DiHypergraph
+=====================================
+
+.. currentmodule:: xgi.classes.dihypergraph
+
+.. autoclass:: DiHypergraph
+   :show-inheritance:
+   :members:
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~DiHypergraph.edges
+      ~DiHypergraph.nodes
+      ~DiHypergraph.num_edges
+      ~DiHypergraph.num_nodes
+
+
+   .. rubric:: Methods that modify the structure
+
+   .. autosummary::
+      :nosignatures:
+
+      ~DiHypergraph.add_node
+      ~DiHypergraph.add_edge
+      ~DiHypergraph.add_nodes_from
+      ~DiHypergraph.add_edges_from
+      ~DiHypergraph.remove_node
+      ~DiHypergraph.remove_edge
+      ~DiHypergraph.remove_nodes_from
+      ~DiHypergraph.remove_edges_from
+      ~DiHypergraph.clear
+      ~DiHypergraph.copy
diff --git a/docs/source/api/classes/xgi.classes.dihypergraph.rst b/docs/source/api/classes/xgi.classes.dihypergraph.rst
@@ -0,0 +1,14 @@
+xgi.classes.dihypergraph
+========================
+
+.. currentmodule:: xgi.classes.dihypergraph
+
+.. automodule:: xgi.classes.dihypergraph
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: .
+      :nosignatures:
+
+        DiHypergraph
diff --git a/docs/source/api/classes/xgi.classes.direportviews.DiEdgeView.rst b/docs/source/api/classes/xgi.classes.direportviews.DiEdgeView.rst
@@ -0,0 +1,28 @@
+xgi.classes.direportviews.DiEdgeView
+====================================
+
+.. currentmodule:: xgi.classes.direportviews
+
+.. autoclass:: DiEdgeView
+   :show-inheritance:
+   :members:
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~DiEdgeView.ids
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~DiEdgeView.members
+      ~DiEdgeView.dimembers
+      ~DiEdgeView.head
+      ~DiEdgeView.tail
+      ~DiIDView.filterby
+      ~DiIDView.filterby_attr
diff --git a/docs/source/api/classes/xgi.classes.direportviews.DiIDView.rst b/docs/source/api/classes/xgi.classes.direportviews.DiIDView.rst
@@ -0,0 +1,18 @@
+xgi.classes.direportviews.DiIDView
+==================================
+
+.. currentmodule:: xgi.classes.direportviews
+
+.. autoclass:: DiIDView
+   :show-inheritance:
+   :members:
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~DiIDView.from_view
+      ~DiIDView.filterby
+      ~DiIDView.filterby_attr
diff --git a/docs/source/api/classes/xgi.classes.direportviews.DiNodeView.rst b/docs/source/api/classes/xgi.classes.direportviews.DiNodeView.rst
@@ -0,0 +1,26 @@
+xgi.classes.direportviews.DiNodeView
+====================================
+
+.. currentmodule:: xgi.classes.direportviews
+
+.. autoclass:: DiNodeView
+   :show-inheritance:
+   :members:
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~DiNodeView.ids
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~DiNodeView.memberships
+      ~DiNodeView.dimemberships
+      ~DiIDView.filterby
+      ~DiIDView.filterby_attr
diff --git a/docs/source/api/classes/xgi.classes.direportviews.rst b/docs/source/api/classes/xgi.classes.direportviews.rst
@@ -0,0 +1,16 @@
+xgi.classes.direportviews
+=========================
+
+.. currentmodule:: xgi.classes.direportviews
+
+.. automodule:: xgi.classes.direportviews
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: .
+      :nosignatures:
+
+        DiIDView
+        DiNodeView
+        DiEdgeView
diff --git a/docs/source/api/classes/xgi.classes.reportviews.EdgeView.rst b/docs/source/api/classes/xgi.classes.reportviews.EdgeView.rst
@@ -12,7 +12,7 @@ xgi.classes.reportviews.EdgeView
 
    .. autosummary::
 
-      ~NodeView.ids
+      ~EdgeView.ids
 
 
    .. rubric:: Methods

diff --git a/docs/source/api/stats.rst b/docs/source/api/stats.rst
@@ -11,6 +11,8 @@ stats package
 
    ~xgi.stats.nodestats
    ~xgi.stats.edgestats
+   ~xgi.stats.dinodestats
+   ~xgi.stats.diedgestats
 
 
 .. rubric:: Classes
@@ -21,8 +23,12 @@ stats package
 
    ~xgi.stats.NodeStat
    ~xgi.stats.EdgeStat
+   ~xgi.stats.DiNodeStat
+   ~xgi.stats.DiEdgeStat
    ~xgi.stats.MultiNodeStat
    ~xgi.stats.MultiEdgeStat
+   ~xgi.stats.MultiDiNodeStat
+   ~xgi.stats.MultiDiEdgeStat
 
 
 .. rubric:: Decorators
@@ -33,3 +39,5 @@ stats package
 
    ~xgi.stats.nodestat_func
    ~xgi.stats.edgestat_func
+   ~xgi.stats.dinodestat_func
+   ~xgi.stats.diedgestat_func
diff --git a/docs/source/api/stats/xgi.stats.DiEdgeStat.rst b/docs/source/api/stats/xgi.stats.DiEdgeStat.rst
@@ -0,0 +1,34 @@
+xgi.stats.DiEdgeStat
+====================
+
+.. currentmodule:: xgi.stats
+
+.. autoclass:: DiEdgeStat
+   :show-inheritance:
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~DiEdgeStat.name
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~DiEdgeStat.asdict
+      ~DiEdgeStat.aslist
+      ~DiEdgeStat.asnumpy
+      ~DiEdgeStat.aspandas
+      ~DiEdgeStat.max
+      ~DiEdgeStat.mean
+      ~DiEdgeStat.median
+      ~DiEdgeStat.min
+      ~DiEdgeStat.std
+      ~DiEdgeStat.var
+      ~DiEdgeStat.moment
diff --git a/docs/source/api/stats/xgi.stats.DiNodeStat.rst b/docs/source/api/stats/xgi.stats.DiNodeStat.rst
@@ -0,0 +1,33 @@
+xgi.stats.DiNodeStat
+====================
+
+.. currentmodule:: xgi.stats
+
+.. autoclass:: DiNodeStat
+   :show-inheritance:
+   :members:
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~DiNodeStat.name
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~DiNodeStat.asdict
+      ~DiNodeStat.aslist
+      ~DiNodeStat.asnumpy
+      ~DiNodeStat.aspandas
+      ~DiNodeStat.max
+      ~DiNodeStat.mean
+      ~DiNodeStat.median
+      ~DiNodeStat.min
+      ~DiNodeStat.std
+      ~DiNodeStat.var
+      ~DiNodeStat.moment
diff --git a/docs/source/api/stats/xgi.stats.MultiDiEdgeStat.rst b/docs/source/api/stats/xgi.stats.MultiDiEdgeStat.rst
@@ -0,0 +1,27 @@
+xgi.stats.MultiDiEdgeStat
+=========================
+
+.. currentmodule:: xgi.stats
+
+.. autoclass:: MultiDiEdgeStat
+   :show-inheritance:
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~MultiDiEdgeStat.name
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~MultiDiEdgeStat.asdict
+      ~MultiDiEdgeStat.aslist
+      ~MultiDiEdgeStat.asnumpy
+      ~MultiDiEdgeStat.aspandas
diff --git a/docs/source/api/stats/xgi.stats.MultiDiNodeStat.rst b/docs/source/api/stats/xgi.stats.MultiDiNodeStat.rst
@@ -0,0 +1,27 @@
+xgi.stats.MultiDiNodeStat
+=========================
+
+.. currentmodule:: xgi.stats
+
+.. autoclass:: MultiDiNodeStat
+   :show-inheritance:
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~MultiDiNodeStat.name
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~MultiDiNodeStat.asdict
+      ~MultiDiNodeStat.aslist
+      ~MultiDiNodeStat.asnumpy
+      ~MultiDiNodeStat.aspandas
diff --git a/docs/source/api/stats/xgi.stats.MultiEdgeStat.rst b/docs/source/api/stats/xgi.stats.MultiEdgeStat.rst
@@ -21,7 +21,7 @@
    .. autosummary::
       :nosignatures:
 
-      ~MultiNodeStat.asdict
-      ~MultiNodeStat.aslist
-      ~MultiNodeStat.asnumpy
-      ~MultiNodeStat.aspandas
+      ~MultiEdgeStat.asdict
+      ~MultiEdgeStat.aslist
+      ~MultiEdgeStat.asnumpy
+      ~MultiEdgeStat.aspandas
diff --git a/docs/source/api/stats/xgi.stats.diedgestat_func.rst b/docs/source/api/stats/xgi.stats.diedgestat_func.rst
@@ -0,0 +1,6 @@
+xgi.stats.diedgestat\_func
+==========================
+
+.. currentmodule:: xgi.stats
+
+.. autofunction:: diedgestat_func
diff --git a/docs/source/api/stats/xgi.stats.diedgestats.rst b/docs/source/api/stats/xgi.stats.diedgestats.rst
@@ -0,0 +1,16 @@
+xgi.stats.diedgestats
+=====================
+
+.. currentmodule:: xgi.stats.diedgestats
+
+.. automodule:: xgi.stats.diedgestats
+
+   .. rubric:: Functions
+
+   .. autofunction:: attrs
+   .. autofunction:: order
+   .. autofunction:: size
+   .. autofunction:: head_order
+   .. autofunction:: head_size
+   .. autofunction:: tail_order
+   .. autofunction:: tail_size
diff --git a/docs/source/api/stats/xgi.stats.dinodestat_func.rst b/docs/source/api/stats/xgi.stats.dinodestat_func.rst
@@ -0,0 +1,6 @@
+xgi.stats.dinodestat\_func
+==========================
+
+.. currentmodule:: xgi.stats
+
+.. autofunction:: dinodestat_func
diff --git a/docs/source/api/stats/xgi.stats.dinodestats.rst b/docs/source/api/stats/xgi.stats.dinodestats.rst
@@ -0,0 +1,13 @@
+xgi.stats.dinodestats
+=====================
+
+.. currentmodule:: xgi.stats.dinodestats
+
+.. automodule:: xgi.stats.dinodestats
+
+   .. rubric:: Functions
+
+   .. autofunction:: attrs
+   .. autofunction:: degree
+   .. autofunction:: in_degree
+   .. autofunction:: out_degree