search_tangles_uncrossed#

tangles.convenience.search_tangles_uncrossed(separations: SetSeparationSystemBase | ndarray, min_agreement: int, order_func: Callable[[ndarray], ndarray], max_number_of_seps: int | None = None, progress_callback=None, sep_metadata: list | ndarray = None) UncrossingSweep#

Search tangles, uncross crossing distinguishers and return an object containing the result.

Parameters#

separationsSetSeparationSystem, FeatureSystem or np.ndarray

A bunch of separations.

If its type is an np.ndarray and the array contains exactly three unique values, a SetSeparationSystem is created. In this case, the two (possibly overlapping) sides of the separations are defined by the non-positive values and the non-negative values, respectively.

If its type is an np.ndarray and the array contains less or more than three values, a FeatureSystem is created with non-positive values defining one side and positive values the other side of a separation (in each column).

min_agreementint

The minimum intersection size of three separations.

max_number_of_sepsint

Maximal number of separations that should be added.

order_funcSetSeparationOrderFunction

Used to compute the order of each separation. The separations are appended in ascending order. A SetSeparationOrderFunction is a Callable[[np.ndarray], np.ndarray].

progress_callbackDefaultProgressCallback or callable

A callable providing a progress indication (see DefaultProgressCallback for reference).

sep_metadatalist or np.ndarray

The metadata for separations. Only used if separations is of type np.ndarray.

Returns#

UncrossingSweep

A tangle search object containing the result of the search.