dash.assert.symmetricMatrices

Throw error if elements along the third dimension are not symmetric matrices


Syntax



Description

dash.assert.symmetricMatrices(X)

Given a numeric 3D array, checks that each each element along the third dimension is a symmetric matrix. Throws an error if not. NaN elements are replaced with a -999 placeholder to allow symmetric comparison of NaN elements. If the placement of all NaN elements is symmetric, then the input will pass the assertion.

dash.assert.symmetricMatrices(X, name, header)

Customize error messages and IDs.


Input Arguments

X

numeric 3*D* array
The input being checked

name

string scalar
The name of the input