Skip to content

Commit 2e0b0c5

Browse files
committed
review comment
1 parent a75921e commit 2e0b0c5

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

docs/src/user_interface/matrix_functions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ MatrixAlgebraKit.MatrixFunctionViaEigh
4242

4343
The functions below ([`squareroot`](@ref), [`logarithm`](@ref) and [`power`](@ref) with fractional powers) are only defined for matrices whose eigenvalues avoid (part of) the negative real axis, and their principal values are complex whenever eigenvalues on that axis are present.
4444
In MatrixAlgebraKit, we aim to keep type stability, and thus the scalar type of the output always matches that of the input.
45-
As such, a real matrix with eigenvalues on the negative real axis leads to a `DomainError`, you should pass a complex matrix instead to obtain the complex principal value.
45+
As such, a real matrix with eigenvalues on the negative real axis leads to a `DomainError`.
46+
You should pass a complex matrix instead to obtain the complex principal value.
4647
To avoid spurious errors for eigenvalues that lie on the negative real axis only because of rounding errors (e.g. a positive semidefinite matrix with a tiny negative eigenvalue), eigenvalues within an absolute tolerance `domain_atol` of the domain boundary are clamped onto it.
4748
This tolerance defaults to [`default_domain_atol`](@ref) and can be specified explicitly for the algorithms that support it, e.g. `MatrixFunctionViaEigh(eigh_alg; domain_atol=...)`.
4849

0 commit comments

Comments
 (0)