shapiq.utils.transform_array_to_coalitions

shapiq.utils.transform_array_to_coalitions(coalitions)

Transforms a 2d one-hot matrix of coalitions into a list of tuples.

Parameters:

coalitions (ndarray[tuple[Any, ...], dtype[bool]]) – A binary array of coalitions.

Return type:

Collection[tuple[int, ...]]

Returns:

List of coalitions as tuples.

Examples

>>> coalitions = np.array([[True, True, False], [False, True, True], [True, False, True]])
>>> transform_array_to_coalitions(coalitions)
[(0, 1), (1, 2), (0, 2)]

>>> coalitions = np.array([[False, False, False], [True, True, True]])
>>> transform_array_to_coalitions(coalitions)
[(), (0, 1, 2)]