samplomatic.aliases

Type Aliases

samplomatic.aliases.EdgeLayout

A map from graph edge indices to coordinate arrays specifying a curved path.

The arrays need to have at least one entry so that there is somewhere to put the edge’s arrow. The arrays need not include the end-points; those are inferred from a node layout.

alias of dict[int, ndarray[tuple[int, 2], dtype[float]]]

samplomatic.aliases.GraphLayout: TypeAlias = dict[int, tuple[float, float]] | tuple[dict[int, tuple[float, float]], dict[int, numpy.ndarray[tuple[int, 2], numpy.dtype[float]]]]

A node layout, or a node layout and an edge layout.

The graph plotter will infer linear edges in the former case.

class samplomatic.aliases.LayoutMethod(*args, **kwargs)

A callable that accepts a graph and returns a coordinate layout.

samplomatic.aliases.LayoutPresets

Preset layout methods for graph plotting.

• 'auto': Use some graphviz method if installed, use 'spring' otherwise.

• 'graphviz': Use graphviz with dot and splined edges.

• 'graphviz_curved': Use graphviz with dot and curved edges.

• 'graphviz_line': Use graphviz with dot and straight edges.

• 'spring': Use the rustworkx spring layout method.

alias of Literal[‘auto’, ‘spring’, ‘graphviz’, ‘graphviz_curved’, ‘graphviz_line’]

samplomatic.aliases.NodeLayout

A map from graph node indices to \((x, y)\) coordinates.

alias of dict[int, tuple[float, float]]

class samplomatic.aliases.NodeRanker(*args, **kwargs)

Specifies a node ranking that can be used by layout methods to group nodes topologically.

A return value of None signifies no rank specified.