netket.graph.AbstractGraph

netket.graph.AbstractGraph#

class netket.graph.AbstractGraph[source]#

Bases: ABC

Abstract class for NetKet graph objects.

Inheritance
Inheritance diagram of netket.graph.AbstractGraph
__init__()#
Attributes
edge_colors#

Sequence of edge colors, in the order of the edges returned by self.edges.

n_edges#

The number of edges in the graph.

n_nodes#

The number of nodes (or vertices) in the graph

Methods
abstractmethod adjacency_list()[source]#

List containing the adjacency list of the graph where each node is represented by an integer in [0, n_nodes)

Return type:

list[list]

abstractmethod automorphisms()[source]#

Symmetry group containing the automorphisms of the graph

abstractmethod distances()[source]#

Return the integer graph distance between all pairs \(i,j\) of sites in the graph.

The graph distance is the shortest-path length, i.e. the minimum number of edges connecting two sites. The distance between unconnected nodes (no path exists between them) is set to \(-1\).

Return type:

list[list]

abstractmethod edges(return_color=False, filter_color=None)[source]#

Returns the sequence of edges of the graph.

Parameters:

  • return_color (bool) – If True, return edges with added color information.

  • filter_color (int | None) – If set, return only edges of the given color.

Return type:

Union[Sequence[tuple[int, int]], Sequence[tuple[int, int, int]]]

Returns:

A sequence of edges as tuples (i, j) or, if return_color is passed, a sequence of tuples (i, j, c) with c indicating the color of the respective edge.

abstractmethod is_bipartite()[source]#

True if the graph is bipartite

Return type:

bool

abstractmethod is_connected()[source]#

True if the graph is connected

Return type:

bool

abstractmethod nodes()[source]#

Iterator over the nodes of the graph

Return type:

Sequence[int]