Skip to content

Commit a70504f

Browse files
authored
A few fixes to the bkfact docstring (#25316)
Adjust signature of `bkfact!` Clarify meaning of ' for complex symmetric matrices Pivoting matrix needs transposition
1 parent e24e50a commit a70504f

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

base/linalg/bunchkaufman.jl

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ BunchKaufman(A::AbstractMatrix{T}, ipiv::Vector{BlasInt}, uplo::Char, symmetric:
1717
BunchKaufman{T,typeof(A)}(A, ipiv, uplo, symmetric, rook, info)
1818

1919
"""
20-
bkfact!(A, uplo::Symbol=:U, symmetric::Bool=issymmetric(A), rook::Bool=false) -> BunchKaufman
20+
bkfact!(A, rook::Bool=false) -> BunchKaufman
2121
2222
`bkfact!` is the same as [`bkfact`](@ref), but saves space by overwriting the
2323
input `A`, instead of creating a copy.
@@ -43,14 +43,12 @@ end
4343
"""
4444
bkfact(A, rook::Bool=false) -> BunchKaufman
4545
46-
Compute the Bunch-Kaufman [^Bunch1977] factorization of a symmetric or Hermitian matrix `A` as ``PUDU'P`` or ``PLDL'P``, depending on which triangle is stored in `A`, and return a `BunchKaufman` object.
46+
Compute the Bunch-Kaufman [^Bunch1977] factorization of a symmetric or Hermitian matrix `A` as ``P'*U*D*U'*P`` or ``P'*L*D*L'*P``, depending on which triangle is stored in `A`, and return a `BunchKaufman` object. Note that if `A` is complex symmetric then `U'` and `L'` denote the unconjugated transposes, i.e. `Transpose(U)` and `Transpose(L)`.
4747
4848
If `rook` is `true`, rook pivoting is used. If `rook` is false, rook pivoting is not used.
4949
5050
The following functions are available for `BunchKaufman` objects: [`size`](@ref), `\\`, [`inv`](@ref), [`issymmetric`](@ref), [`ishermitian`](@ref), [`getindex`](@ref).
5151
52-
Note that `P` is symmetric, so ``P=P⁻¹=P'``.
53-
5452
[^Bunch1977]: J R Bunch and L Kaufman, Some stable methods for calculating inertia and solving symmetric linear systems, Mathematics of Computation 31:137 (1977), 163-179. [url](http://www.ams.org/journals/mcom/1977-31-137/S0025-5718-1977-0428694-0/).
5553
5654
# Examples
@@ -117,7 +115,7 @@ end
117115
getproperty(B::BunchKaufman, d::Symbol)
118116
119117
Extract the factors of the Bunch-Kaufman factorization `B`. The factorization can take the
120-
two forms `P*L*D*L'*P` or `P*U*D*U'*P` (or `L*D*Transpose(L)` in the complex symmetric case)
118+
two forms `P'*L*D*L'*P` or `P'*U*D*U'*P` (or `L*D*Transpose(L)` in the complex symmetric case)
121119
where `P` is a (symmetric) permutation matrix, `L` is a `UnitLowerTriangular` matrix, `U` is a
122120
`UnitUpperTriangular`, and `D` is a block diagonal symmetric or Hermitian matrix with
123121
1x1 or 2x2 blocks. The argument `d` can be

0 commit comments

Comments
 (0)