API Reference

This page gives an overview of all public XGI objects, functions and methods. All classes and functions are exposed in xgi.* namespace are public

XGI is organized into the following subpackages:

• xgi.algorithms: Function to compute classic algorightms on higher-order networks

• xgi.convert: Functions to convert between different representations of the data

• xgi.core: Classes for the core datastructures and views

• xgi.drawing: Functions for plotting

• xgi.dynamics: Functions to simulate given dynamical processes

• xgi.generators: Functions to generate higher-order networks from models

• xgi.linalg: Functions to compute matrix and tensors representations

• xgi.readwrite: Functions to load and store higher-order networks in standard formats

• xgi.stats: Functions to compute node and edge statistics in a single interface

• xgi.utils: Small utility functions

Note

This page describes release 0.9.4 of XGI. Find out more about this release and previous releases in the release notes.

• Algorithms
  • xgi.algorithms.assortativity
  • xgi.algorithms.centrality
  • xgi.algorithms.clustering
  • xgi.algorithms.connected
  • xgi.algorithms.properties
  • xgi.algorithms.shortest_path
  • xgi.algorithms.simpliciality
• Convert
  • xgi.convert.bipartite_edges
  • xgi.convert.bipartite_graph
  • xgi.convert.encapsulation_dag
  • xgi.convert.graph
  • xgi.convert.hif_dict
  • xgi.convert.higher_order_network
  • xgi.convert.hyperedges
  • xgi.convert.hypergraph_dict
  • xgi.convert.incidence
  • xgi.convert.line_graph
  • xgi.convert.pandas
  • xgi.convert.simplex
• Core functionality
  • xgi.core.hypergraph
  • xgi.core.dihypergraph
  • xgi.core.simplicialcomplex
  • xgi.core.views
  • xgi.core.globalviews
• Drawing
  • xgi.drawing.layout
  • xgi.drawing.draw
• Dynamics
  • xgi.dynamics.synchronization
• Generators
  • xgi.generators.classic
  • xgi.generators.simple
  • xgi.generators.lattice
  • xgi.generators.random
  • xgi.generators.uniform
  • xgi.generators.simplicial_complexes
  • xgi.generators.randomizing
• Linear Algebra
  • xgi.linalg.hypergraph_matrix
  • xgi.linalg.laplacian_matrix
  • xgi.linalg.hodge_matrix
• I/O
  • xgi.readwrite.bigg_data
  • xgi.readwrite.bipartite
  • xgi.readwrite.edgelist
  • xgi.readwrite.hif
  • xgi.readwrite.incidence
  • xgi.readwrite.json
  • xgi.readwrite.xgi_data
• Stats for nodes and edges
  • xgi.stats.nodestat_func
  • xgi.stats.edgestat_func
  • xgi.stats.nodestats
  • xgi.stats.edgestats
  • xgi.stats.NodeStat
  • xgi.stats.EdgeStat
  • xgi.stats.MultiNodeStat
  • xgi.stats.MultiEdgeStat
  • xgi.stats.dinodestat_func
  • xgi.stats.diedgestat_func
  • xgi.stats.dinodestats
  • xgi.stats.diedgestats
  • xgi.stats.DiNodeStat
  • xgi.stats.DiEdgeStat
  • xgi.stats.MultiDiNodeStat
  • xgi.stats.MultiDiEdgeStat
• Utilities
  • xgi.utils.utilities