definiteness
¶
Hermitian definiteness checks.
Eigenvalues with absolute value at most 1e-10 count as zero.
positive_definite
¶
Return whether a matrix is positive definite.
A matrix is positive definite when it is Hermitian and every eigenvalue is
greater than 1e-10.
Parameters:
-
matrix(ndarray) –Square matrix to check.
Returns:
-
bool–Trueif the matrix is Hermitian and every eigenvalue is greater -
bool–than
1e-10, elseFalse.
Examples:
The identity is positive definite:
import numpy as np
from shadowsim.utils.definiteness import positive_definite
print(positive_definite(np.eye(3)))
A zero eigenvalue makes the matrix fail the strict test:
import numpy as np
from shadowsim.utils.definiteness import positive_definite
print(positive_definite(np.diag([0.0, 1.0, 2.0])))
Source code in shadowsim/utils/definiteness.py
positive_semidefinite
¶
Return whether a matrix is positive semidefinite.
A matrix is positive semidefinite when it is Hermitian and every eigenvalue
is at least -1e-10.
Parameters:
-
matrix(ndarray) –Square matrix to check.
Returns:
-
bool–Trueif the matrix is Hermitian and every eigenvalue is at least -
bool–-1e-10, elseFalse.
Examples:
A diagonal matrix with a zero eigenvalue is positive semidefinite but not positive definite:
import numpy as np
from shadowsim.utils.definiteness import positive_semidefinite
print(positive_semidefinite(np.diag([0.0, 1.0, 2.0])))
Source code in shadowsim/utils/definiteness.py
negative_definite
¶
Return whether a matrix is negative definite.
A matrix is negative definite when it is Hermitian and every eigenvalue is
less than -1e-10.
Parameters:
-
matrix(ndarray) –Square matrix to check.
Returns:
-
bool–Trueif the matrix is Hermitian and every eigenvalue is less than -
bool–-1e-10, elseFalse.
Examples:
A negative multiple of the identity is negative definite:
import numpy as np
from shadowsim.utils.definiteness import negative_definite
print(negative_definite(-np.eye(2)))
Source code in shadowsim/utils/definiteness.py
negative_semidefinite
¶
Return whether a matrix is negative semidefinite.
A matrix is negative semidefinite when it is Hermitian and every eigenvalue
is at most 1e-10.
Parameters:
-
matrix(ndarray) –Square matrix to check.
Returns:
-
bool–Trueif the matrix is Hermitian and every eigenvalue is at most -
bool–1e-10, elseFalse.
Examples:
A diagonal matrix with a zero and a negative entry is negative semidefinite:
import numpy as np
from shadowsim.utils.definiteness import negative_semidefinite
print(negative_semidefinite(np.diag([0.0, -1.0])))
Source code in shadowsim/utils/definiteness.py
indefinite
¶
Return whether a matrix is indefinite.
A matrix is indefinite when it is Hermitian and it has at least one
eigenvalue greater than 1e-10 and at least one less than -1e-10.
Parameters:
-
matrix(ndarray) –Square matrix to check.
Returns:
-
bool–Trueif the matrix is Hermitian and its eigenvalues include both a -
bool–value greater than
1e-10and a value less than-1e-10, else -
bool–False.
Examples:
Pauli \(Z\) is indefinite:
import numpy as np
from shadowsim.utils.definiteness import indefinite
Z = np.array([[1.0, 0.0], [0.0, -1.0]])
print(indefinite(Z))