#############
stats package
#############

.. automodule:: xgi.stats

.. seealso::

   :doc:`/stats_cheatsheet`
      Quick reference for output formats, filtering, custom stats, and more.

   :doc:`/api/tutorials/focus_6`
      Step-by-step tutorial on the stats interface.

.. admonition:: Available statistics
   
   .. rubric:: Hypergraphs and simplicial complexes

   *Statistics of nodes*

   .. autosummary::
      :nosignatures:

      ~xgi.stats.nodestats.attrs
      ~xgi.stats.nodestats.average_neighbor_degree
      ~xgi.stats.nodestats.clique_eigenvector_centrality
      ~xgi.stats.nodestats.clustering_coefficient
      ~xgi.stats.nodestats.degree
      ~xgi.stats.nodestats.h_eigenvector_centrality
      ~xgi.stats.nodestats.katz_centrality
      ~xgi.stats.nodestats.local_clustering_coefficient
      ~xgi.stats.nodestats.local_edit_simpliciality
      ~xgi.stats.nodestats.local_face_edit_simpliciality
      ~xgi.stats.nodestats.local_simplicial_fraction
      ~xgi.stats.nodestats.node_edge_centrality
      ~xgi.stats.nodestats.pos
      ~xgi.stats.nodestats.two_node_clustering_coefficient
      ~xgi.stats.nodestats.z_eigenvector_centrality

   *Statistics of edges*

   .. autosummary::
      :nosignatures:

      ~xgi.stats.edgestats.attrs
      ~xgi.stats.edgestats.node_edge_centrality
      ~xgi.stats.edgestats.order
      ~xgi.stats.edgestats.size

   *Corresponding decorators*

   .. autosummary::
      :toctree: stats
      :nosignatures:

      ~xgi.stats.nodestat_func
      ~xgi.stats.edgestat_func

   *Corresponding modules*

   .. autosummary::
      :toctree: stats

      ~xgi.stats.nodestats
      ~xgi.stats.edgestats

   *Corresponding classes*

   .. autosummary::
      :toctree: stats
      :nosignatures:

      ~xgi.stats.NodeStat
      ~xgi.stats.EdgeStat
      ~xgi.stats.MultiNodeStat
      ~xgi.stats.MultiEdgeStat

   .. rubric:: Directed hypergraphs
   

   *Statistics of nodes*

   .. autosummary::
      :nosignatures:

      ~xgi.stats.dinodestats.attrs
      ~xgi.stats.dinodestats.degree
      ~xgi.stats.dinodestats.in_degree
      ~xgi.stats.dinodestats.out_degree
      ~xgi.stats.dinodestats.pos

   *Statistics of edges*

   .. autosummary::
      :nosignatures:

      ~xgi.stats.diedgestats.attrs
      ~xgi.stats.diedgestats.head_order
      ~xgi.stats.diedgestats.head_size
      ~xgi.stats.diedgestats.order
      ~xgi.stats.diedgestats.size
      ~xgi.stats.diedgestats.tail_order
      ~xgi.stats.diedgestats.tail_size

   *Corresponding decorators*

   .. autosummary::
      :toctree: stats
      :nosignatures:

      ~xgi.stats.dinodestat_func
      ~xgi.stats.diedgestat_func

   *Corresponding modules*

   .. autosummary::
      :toctree: stats

      ~xgi.stats.dinodestats
      ~xgi.stats.diedgestats


   *Corresponding classes*

   .. autosummary::
      :toctree: stats
      :nosignatures:

      ~xgi.stats.DiNodeStat
      ~xgi.stats.DiEdgeStat
      ~xgi.stats.MultiDiNodeStat
      ~xgi.stats.MultiDiEdgeStat