check_symmetric

sklearn.utils.validation.check_symmetric(array, *, tol=1e-10, raise_warning=True, raise_exception=False)

Stellt sicher, dass das Array 2D, quadratisch und symmetrisch ist.

Wenn das Array nicht symmetrisch ist, wird eine symmetrisierte Version zurückgegeben. Optional wird eine Warnung oder Ausnahme ausgelöst, wenn die Matrix nicht symmetrisch ist.

Parameter:

array{ndarray, sparse matrix}

Zu prüfendes / zu konvertierendes Eingabeobjekt. Muss zweidimensional und quadratisch sein, andernfalls wird ein ValueError ausgelöst.

tolfloat, default=1e-10

Absolute Toleranz für die Äquivalenz von Arrays. Standard = 1E-10.

raise_warningbool, default=True

Wenn True, wird eine Warnung ausgelöst, wenn eine Konvertierung erforderlich ist.

raise_exceptionbool, default=False

Wenn True, wird eine Ausnahme ausgelöst, wenn das Array nicht symmetrisch ist.

Gibt zurück:

array_sym{ndarray, sparse matrix}

Symmetrisierte Version des Eingabearrays, d. h. der Durchschnitt von array und array.transpose(). Wenn spärlich, werden doppelte Einträge zuerst summiert und Nullen eliminiert.

Beispiele

>>> import numpy as np
>>> from sklearn.utils.validation import check_symmetric
>>> symmetric_array = np.array([[0, 1, 2], [1, 0, 1], [2, 1, 0]])
>>> check_symmetric(symmetric_array)
array([[0, 1, 2],
       [1, 0, 1],
       [2, 1, 0]])
>>> from scipy.sparse import csr_matrix
>>> sparse_symmetric_array = csr_matrix(symmetric_array)
>>> check_symmetric(sparse_symmetric_array)
<Compressed Sparse Row sparse matrix of dtype 'int64'
    with 6 stored elements and shape (3, 3)>