netket.graph.AbstractGraph¶

class netket.graph.AbstractGraph¶

Bases: abc.ABC

Abstract class for NetKet graph objects.

Inheritance

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

Attributes

edge_colors¶

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

Return type: Sequence[int]

n_edges¶

The number of edges in the graph.

Return type: int

n_nodes¶

The number of nodes (or vertices) in the graph

Return type: int

Methods

abstract 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]

abstract automorphisms()[source]¶: Symmetry group containing the automorphisms of the graph

abstract distances()[source]¶

List containing the distances between the nodes. The distance between unconnected nodes (no path exists between them) is set to -1

Return type: List[List]

abstract 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 (Optional[int]) – 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.

abstract is_bipartite()[source]¶

True if the graph is bipartite

Return type: bool

abstract is_connected()[source]¶

True if the graph is connected

Return type: bool

abstract nodes()[source]¶

Iterator over the nodes of the graph

Return type: Iterator[int]