Skip to content

Commit

Permalink
Fix documentation: eigenspace does not return a Vector (#2034)
Browse files Browse the repository at this point in the history
  • Loading branch information
joschmitt authored Feb 24, 2025
1 parent 499be9d commit f23f1f3
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/matrix.jl
Original file line number Diff line number Diff line change
Expand Up @@ -255,11 +255,12 @@ end

@doc raw"""
eigenspace(M::MatElem{T}, lambda::T; side::Symbol = :left)
where T <: FieldElem -> Vector{MatElem{T}}
where T <: FieldElem -> MatElem{T}
Return a basis of the eigenspace of $M$ with respect to the eigenvalue $\lambda$.
If side is `:right`, the right eigenspace is computed, i.e. vectors $v$ such that
$Mv = \lambda v$. If side is `:left`, the left eigenspace is computed, i.e. vectors
Return a matrix whose rows (if `side == :left`) or columns (if `side == :right`)
give a basis of the eigenspace of $M$ with respect to the eigenvalue $\lambda$.
If `side` is `:right`, the right eigenspace is computed, i.e. vectors $v$ such that
$Mv = \lambda v$. If `side` is `:left`, the left eigenspace is computed, i.e. vectors
$v$ such that $vM = \lambda v$.
"""
function eigenspace(M::MatElem{T}, lambda::T; side::Symbol = :left) where T <: FieldElem
Expand Down

0 comments on commit f23f1f3

Please sign in to comment.