tangle_matrix

TangleSearchTree.tangle_matrix(agreement: int = 1, max_level: int | None = None, include_splitting=False, return_nodes=False) → ndarray | tuple[ndarray, list[Tangle]]

Return the tangle matrix of all maximal tangles, taken from the set of tangles of at least the specified agreement.

Guaranteed to return every tangle (on the set of separation ids the sweep knows about) if the limit is below the specified agreement.

Parameters

agreementint

All tangles of at least this agreement value are returned.

max_levelint, optional

Only return tangles with level less than max_level.

Returns

np.ndarray

Tangle matrix.