API Reference
This section documents the public Python API of graphcalc.
The API is organized by mathematical domain and package structure.
- Graphs API
- Graphs Core API
- Core
K_4_free()SimpleGraphaverage_shortest_path_length()bipartite()chordal()claw_free()cograph()connected()connected_and_K_4_free()connected_and_bipartite()connected_and_chordal()connected_and_claw_free()connected_and_cograph()connected_and_cubic()connected_and_eulerian()connected_and_planar()connected_and_regular()connected_and_subcubic()connected_and_triangle_free()cubic()diameter()eulerian()is_C4_free()is_induced_C4_free()isolate_free()nontrivial()order()planar()radius()regular()size()subcubic()tree()triangle_free()closed_neighborhood()neighborhood()set_closed_neighbors()set_neighbors()
- Graphs Data API
- Data
- Graphs Generators API
- Simple Graph Generators
balanced_tree()barabasi_albert_graph()barbell_graph()binomial_tree()complete_graph()cycle_graph()diamond_necklace()erdos_renyi_graph()fan_graph()grid_2d_graph()ladder_graph()path_graph()petersen_graph()powerlaw_cluster_graph()random_geometric_graph()random_regular_graph()star_graph()watts_strogatz_graph()wheel_graph()
- Graphs Invariants API
- classics
- Classics
- coloring predicates
- Coloring Predicates
- core invariants
- Core Invariants
- critical invariants
- Critical Invariants
- cycle invariants
- Cycle Invariants
- degree
- Degree
- domination
- Domination
- graph indices
- Graph Indices
- local invariants
- Local Invariants
- spectral
- Spectral
- transversal invariants
- Transversal Invariants
- zero forcing
- Zero Forcing
- Advanced Coloring Invariants API
- Advanced Coloring Invariants
- Graphs Polytopes API
- Polytopes
- Graphs Visualization API
- Visualization
- Hypergraphs API
- Hypergraphs Core API
- Hypergraph Core
- Hypergraphs Generators API
- Hypergraph Generators
- Hypergraphs Invariants API
- Hypergraph Invariants
berge_girth()is_alpha_acyclic()is_berge_acyclic()average_degree()co_rank()degree_sequence()edge_size_sequence()is_d_regular()is_empty()is_k_uniform()is_regular()is_trivial()maximum_degree()minimum_degree()number_of_edges()number_of_vertices()rank()edge_chromatic_number()edge_coloring()strong_chromatic_number()strong_coloring()weak_chromatic_number()weak_coloring()average_codegree()codegree()lower_shadow()lower_shadow_size()maximum_codegree()minimum_codegree()upper_shadow()upper_shadow_size()has_sunflower()- Definitions
- Functions
domination_number()minimum_dominating_set()minimum_total_dominating_set()total_domination_number()degree_sequence()generalized_annihilation_number()generalized_havel_hakimi_residue()hh_residue_graph_degree_sequence()reverse_degree_sequence()independence_number()maximum_independent_set()edge_cover_number()fractional_matching_number()matching_number()maximum_matching()minimum_edge_cover()is_r_partite_r_uniform()is_clutter()is_intersecting()is_linear()is_pair_covering()is_simple()is_sperner()is_t_intersecting()fractional_transversal_number()minimum_transversal()transversal_number()
- Quantum API
- Quantum States API
- Quantum States
- Quantum State Generators API
- Quantum State Generators
- Quantum State Invariants API
- Quantum State Invariants
- Quantum State Properties API
- Quantum State Properties
- Quantum Channels API
- Quantum Channels
- Quantum Channel Generators API
- Quantum Channel Generators
- Quantum Channel Invariants API
- Quantum Channel Invariants
- Quantum Channel Properties API
- Quantum Channel Properties
- Quantum Measurements API
- Quantum Measurements
- Quantum Measurement Generators API
- Quantum Measurement Generators
- Quantum Measurement Properties API
- Quantum Measurement Properties
- Local Channel Actions API
- Local Channel Actions
- Quantum Dataset Generators API
- Quantum Dataset Generators
- Quantum Dataset Exports API
- Quantum Dataset Exports
- Additive Combinatorics API
- ambient_groups
- sets
- generators
- invariants
additive_energy()cardinality()difference_constant()diffset_defect()diffset_density()diffset_size()doubling_constant()doubling_minus_difference()energy_over_sumset_square()max_difference_representation_count()max_sum_representation_count()normalized_additive_energy()stabilizer_index()stabilizer_size()stabilizer_size_of_sumset()sumset_defect()sumset_density()sumset_size()sumset_stabilizer_index()tripling_constant()
- properties
contains_zero()has_full_diffset()has_full_sumset()has_small_doubling()is_aperiodic()is_coset()is_difference_larger_than_sumset()is_doubling_at_most_2()is_doubling_at_most_3_over_2()is_empty_set()is_periodic()is_sidon()is_subgroup()is_sum_free()is_symmetric()is_trivial_set()is_whole_group()sumset_is_periodic()
- dataset_generators
- dataset_exports
- Solvers API
- Utilities API