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 networksxgi.communities: Functions to detect community structure in higher-order networksxgi.convert: Functions to convert between different representations of the dataxgi.core: Classes for the core datastructures and viewsxgi.drawing: Functions for plottingxgi.dynamics: Functions to simulate given dynamical processesxgi.generators: Functions to generate higher-order networks from modelsxgi.linalg: Functions to compute matrix and tensors representationsxgi.readwrite: Functions to load and store higher-order networks in standard formatsxgi.stats: Functions to compute node and edge statistics in a single interfacexgi.utils: Small utility functions
Note
This page describes the latest XGI development with features that may not be released yet. To see officially released features, visit the API reference for the most recent stable version.
- Algorithms
- Communities
- Convert
- Core functionality
- Drawing
- Dynamics
- Generators
- Linear Algebra
- I/O
- 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