search

classmethod SurveyTangles.search(survey: ~tangles.convenience.survey.Survey, agreement: int, features_or_separations: ~numpy.ndarray | None = None, metadata: list | ~numpy.ndarray | None = None, order: list | ~numpy.ndarray | ~typing.Callable[[~numpy.ndarray], ~numpy.ndarray] | str | None = None, similarity_matrix: ~numpy.ndarray | ~scipy.sparse._matrix.spmatrix = None, feature_factory: ~tangles.convenience.survey_feature_factory.SurveyFeatureFactory | None = None, uncross: bool = False, progress_callback=<tangles.search.progress.DefaultProgressCallback object>) → SurveyTangles

Search tangles.

Returns a SurveyTangles object managing a tangle search on survey data.

Parameters

surveySurvey

A survey object.

agreementint

The currently valid agreement lower bound.

features_or_separationsnp.ndarray or None

A matrix containing the features in its columns.

metadatanp.ndarray or None

A list of metadata corresponding to features_or_separations.

orderlist, np.ndarray, SetSeparationOrderFunction, str or None

A list or np.ndarray of indices, an order function or the name of an order function, indicating the order in which the features are used for building a tangle search tree.

similarity_matrixnp.ndarray or None

A similarity matrix possibly used by the order function.

feature_factorySurveyFeatureFactory or None

An object turning questions (i.e. the rows of survey) into features (or separations). See also SurveyFeatureFactory.

uncrossbool

If True, uncross the features (or separations) that distinguish at least two tangles.

progress_callbackDefaultProgressCallback or callable

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

Returns

SurveyTangles

An object managing a tangle search on survey data.