optiwindnet.terse

Compact, self-describing encodings of solution and routeset links.

Module Contents

class optiwindnet.terse.LinkScope

Bases: enum.StrEnum

Graph layer represented by TerseLinks.

Initialize self. See help(type(self)) for accurate signature.

TOPOLOGY

ROUTESET

class optiwindnet.terse.TerseLinks

Bases: collections.abc.Sequence[int]

Compact links plus the metadata needed to reconstruct their graph.

RADIAL and BRANCHED values use one parent target per non-root node. RINGED values use the flattened route representation. A topology value represents S; a routeset value additionally carries the clone mapping needed to reproduce G against its location graph. Either scope can be bound to an exact location geometry with nodeset_digest.

links: tuple[int, Ellipsis]

topology: optiwindnet.types.Topology

scope: LinkScope

T: int

R: int

B: int = 0

C: int = 0

D: int = 0

clone2prime: tuple[int, Ellipsis] = ()

nodeset_digest: bytes | None = None

__post_init__()

__len__() → int

__iter__() → collections.abc.Iterator[int]

__getitem__(index)

__array__(dtype=None, copy=None) → numpy.ndarray

__repr__() → str

tolist() → list[int]

Return the encoded links as a plain list.

to_dict() → dict[str, Any]

Return a versioned representation suitable for JSON serialization.

classmethod from_dict(data: collections.abc.Mapping[str, Any]) → TerseLinks

Restore a value created by to_dict().

classmethod from_topology(S: networkx.Graph, *, nodeset_digest: bytes | None = None) → TerseLinks

Encode solution topology S, optionally bound to a node set.

classmethod from_routeset(G: networkx.Graph) → TerseLinks

Encode routed solution G, including its clone mapping.

classmethod from_array(links: collections.abc.Sequence[int], *, topology: optiwindnet.types.Topology | str | None = None, R: int | None = None, T: int | None = None) → TerseLinks

Adapt a legacy topology array to a self-describing value.

to_topology(**graph_attrs) → networkx.Graph

Reconstruct topology S.

to_routeset(L: networkx.Graph, **graph_attrs) → networkx.Graph

Reconstruct routeset G against location graph L.