graphbin.graph module

This module contains the Graph class.

class graphbin.graph.Graph(index=<factory>, feature=<factory>, edges=<factory>, _degree=<factory>)

Bases: object

Simple class to represent a Graph structure.

property degree: ndarray[Any, dtype[int64]]

This property returns a view of the degree of each node.

Returns:

A view of the degree of each node.

edges: ndarray[Any, dtype[int64]]

List containing all pairs of edges.

feature: ndarray[Any, dtype[float64]]

List containing the feature value of each node.

index: ndarray[Any, dtype[int64]]

List containing the index of each node.

class graphbin.graph.SyntheticNodes(index=<factory>, feature=<factory>, degree=<factory>)

Bases: object

This class functions as a limited description of a graph, namely only the nodes and their degrees. This description of a graph has no edges.

degree: ndarray[Any, dtype[int64]]

List containing the degree of each node.

feature: ndarray[Any, dtype[float64]]

List containing the feature value of each node.

index: ndarray[Any, dtype[int64]]

List containing the index of each node.

graphbin.graph.numpy_factory_float()

This is a factory function for numpy arrays, but includes type hints to make the static type checker happy.

Return type:

ndarray[Any, dtype[float64]]

Returns:

An empty numpy array.

graphbin.graph.numpy_factory_int()

This is a factory function for numpy arrays, but includes type hints to make the static type checker happy.

Return type:

ndarray[Any, dtype[int64]]

Returns:

An empty numpy array.