API Reference

The API reference gives an overview of TopoNetX, which consists of several modules:

• classes implements the topological domains, e.g., SimplicialComplex, CellComplex, CombinatorialComplex.

• datasets implements utilities to load small datasets on topological domains.

• transform implements functions to transform the topological domain that supports a dataset, effectively “lifting” the dataset onto another domain.

• algorithms implements signal processing techniques on topological domains, such as the eigendecomposition of a laplacian.

• generators implements functions to generate random topological domains.

• readwrite implements functions to read and write topological domains from and to disk.

Packages & Modules

• Classes
  • Atoms
  • Complexes
  • Report Views
• Datasets
  • Utils
  • Graph
  • Mesh
• Transform
  • homology_cycle_cell_complex()
  • graph_to_clique_complex()
  • graph_to_neighbor_complex()
  • weighted_graph_to_vietoris_rips_complex()
• Algorithms
  • connected_component_subcomplexes()
  • connected_components()
  • s_component_subcomplexes()
  • s_connected_components()
  • cell_diameter()
  • cell_diameters()
  • diameter()
  • node_diameters()
  • cell_distance()
  • distance()
  • cell_complex_adjacency_spectrum()
  • cell_complex_hodge_laplacian_spectrum()
  • combinatorial_complex_adjacency_spectrum()
  • hodge_laplacian_eigenvectors()
  • laplacian_beltrami_eigenvectors()
  • laplacian_spectrum()
  • set_hodge_laplacian_eigenvector_attrs()
  • simplicial_complex_adjacency_spectrum()
  • simplicial_complex_hodge_laplacian_spectrum()
• Generators
  • linial_meshulam_complex()
  • multiparameter_linial_meshulam_complex()
  • random_clique_complex()
  • np_cell_complex()
• Read-Write
  • generate_atomlist()
  • load_from_atomlist()
  • parse_atomlist()
  • write_atomlist()
  • load_from_pickle()
  • to_pickle()