Skip to content

Update some wording in the docstring of cholmod.jl #622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 3, 2025
Merged

Update some wording in the docstring of cholmod.jl #622

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0cf9681
Update cholmod.jl
WalterMadelim May 8, 2025
05af962
Merge branch 'JuliaSparse:main' into main
WalterMadelim May 8, 2025
33eb31f
Update cholmod.jl
WalterMadelim May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/solvers/cholmod.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1504,8 +1504,8 @@ end

Compute the Cholesky (``LL'``) factorization of `A`, reusing the symbolic
factorization `F`. `A` must be a [`SparseMatrixCSC`](@ref) or a [`Symmetric`](@ref)/
[`Hermitian`](@ref) view of a `SparseMatrixCSC`. Note that even if `A` doesn't
have the type tag, it must still be symmetric or Hermitian.
[`Hermitian`](@ref) view of a `SparseMatrixCSC`. Note that if `A` doesn't
have the type tag, it must itself be symmetric or Hermitian.

See also [`cholesky`](@ref).

Expand Down Expand Up @@ -1540,8 +1540,8 @@ end

Compute the Cholesky factorization of a sparse positive definite matrix `A`.
`A` must be a [`SparseMatrixCSC`](@ref) or a [`Symmetric`](@ref)/[`Hermitian`](@ref)
view of a `SparseMatrixCSC`. Note that even if `A` doesn't
have the type tag, it must still be symmetric or Hermitian.
view of a `SparseMatrixCSC`. Note that if `A` doesn't
have the type tag, it must itself be symmetric or Hermitian.
If `perm` is not given, a fill-reducing permutation is used.
`F = cholesky(A)` is most frequently used to solve systems of equations with `F\\b`,
but also the methods [`diag`](@ref), [`det`](@ref), and
Expand Down Expand Up @@ -1674,8 +1674,8 @@ end

Compute the ``LDL'`` factorization of `A`, reusing the symbolic factorization `F`.
`A` must be a [`SparseMatrixCSC`](@ref) or a [`Symmetric`](@ref)/[`Hermitian`](@ref)
view of a `SparseMatrixCSC`. Note that even if `A` doesn't
have the type tag, it must still be symmetric or Hermitian.
view of a `SparseMatrixCSC`. Note that if `A` doesn't
have the type tag, it must itself be symmetric or Hermitian.

See also [`ldlt`](@ref).

Expand Down Expand Up @@ -1716,8 +1716,8 @@ end

Compute the ``LDL'`` factorization of a sparse matrix `A`.
`A` must be a [`SparseMatrixCSC`](@ref) or a [`Symmetric`](@ref)/[`Hermitian`](@ref)
view of a `SparseMatrixCSC`. Note that even if `A` doesn't
have the type tag, it must still be symmetric or Hermitian.
view of a `SparseMatrixCSC`. Note that if `A` doesn't
have the type tag, it must itself be symmetric or Hermitian.
A fill-reducing permutation is used. `F = ldlt(A)` is most frequently
used to solve systems of equations `A*x = b` with `F\\b`. The returned
factorization object `F` also supports the methods [`diag`](@ref),
Expand Down
Loading