Added simpliciality measures (#587)

* Add simpliciality measures

* add references

* remove unnecessary trie functionality

* added unit tests

* added unit tests

* simplify simplify simpliciality

* fix broken tests

* add cross-refs

* fix tolerance issues

* fix tests

* update pubs

* fix a small potential error in the simpliciality code

* added more extensive documentation about the simpliciality

* small fix

* update docstrings

* update math

docs/source/api/algorithms.rst

@@ -11,5 +11,6 @@ algorithms package
    ~xgi.algorithms.centrality
    ~xgi.algorithms.clustering
    ~xgi.algorithms.connected
+   ~xgi.algorithms.properties
    ~xgi.algorithms.shortest_path
-   ~xgi.algorithms.properties
+   ~xgi.algorithms.simpliciality

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

@@ -0,0 +1,14 @@
+xgi.algorithms.simpliciality
+============================
+
+.. currentmodule:: xgi.algorithms.simpliciality
+
+.. automodule:: xgi.algorithms.simpliciality
+
+   .. rubric:: Functions
+
+   .. autofunction:: edit_simpliciality
+   .. autofunction:: simplicial_edit_distance
+   .. autofunction:: face_edit_simpliciality
+   .. autofunction:: mean_face_edit_distance
+   .. autofunction:: simplicial_fraction

docs/source/api/stats/xgi.stats.nodestats.rst

@@ -15,4 +15,7 @@
    .. autofunction:: h_eigenvector_centrality
    .. autofunction:: local_clustering_coefficient
    .. autofunction:: node_edge_centrality
-   .. autofunction:: two_node_clustering_coefficient
+   .. autofunction:: two_node_clustering_coefficient
+   .. autofunction:: local_simplicial_fraction
+   .. autofunction:: local_edit_simpliciality
+   .. autofunction:: local_face_edit_simpliciality

docs/source/using-xgi.rst

@@ -37,6 +37,11 @@ Leonie Neuhäuser, Michael Scholkemper, Francesco Tudisco, and Michael T. Schaub
 :bdg-link-primary-line:`Paper <https://doi.org/10.1126/sciadv.adh4053>`
 :bdg-link-primary-line:`Code <https://git.rwth-aachen.de/netsci/publication-2023-learning-the-effective-order-of-a-hypergraph-dynamical-system>`
 
+Yuanzhao Zhang, Per Sebastian Skardal, Federico Battiston, Giovanni Petri, and Maxime Lucas, "Deeper but smaller: Higher-order interactions increase linear stability but shrink basins", *Science Advances* **10**,eado8049 (2024).
+
+:bdg-link-primary-line:`Paper <https://doi.org/10.1126/sciadv.ado8049>`
+:bdg-link-primary-line:`Code <https://github.com/maximelucas/basins_and_triangles>`
+
 2023
 ----
 
@@ -104,10 +109,6 @@ Gonzalo Contreras-Aso, Cristian Pérez-Corral, and Miguel Romance, "Uplifting ed
 :bdg-link-primary-line:`Paper <https://arxiv.org/abs/2310.20335>`
 :bdg-link-primary-line:`Code <https://github.com/LaComarca-Lab/non-uniform-hypergraphs>`
 
-Yuanzhao Zhang, Per Sebastian Skardal, Federico Battiston, Giovanni Petri, and Maxime Lucas, "Deeper but smaller: Higher-order interactions increase linear stability but shrink basins", arXiv:2309.16581 (2023).
-
-:bdg-link-primary-line:`Paper <https://arxiv.org/abs/2309.16581>`
-:bdg-link-primary-line:`Code <https://github.com/maximelucas/basins_and_triangles>`
 
 Theses
 ======