Skip to content

Commit 4b9414a

Browse files
Merge pull request #476 from hexaeder/master
fix default pivot in docstring
2 parents 81c0ac4 + d3fd6c4 commit 4b9414a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/ArrayInterface.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ bunchkaufman_instance(a::Any) = bunchkaufman(a, check = false)
410410
const DEFAULT_CHOLESKY_PIVOT = LinearAlgebra.NoPivot()
411411

412412
"""
413-
cholesky_instance(A, pivot = LinearAlgebra.RowMaximum()) -> cholesky_factorization_instance
413+
cholesky_instance(A, pivot = LinearAlgebra.NoPivot()) -> cholesky_factorization_instance
414414
415415
Returns an instance of the Cholesky factorization object with the correct type
416416
cheaply.
@@ -420,14 +420,14 @@ function cholesky_instance(A::Matrix{T}, pivot = DEFAULT_CHOLESKY_PIVOT) where {
420420
end
421421

422422
"""
423-
cholesky_instance(a::Number, pivot = LinearAlgebra.RowMaximum()) -> a
423+
cholesky_instance(a::Number, pivot = LinearAlgebra.NoPivot()) -> a
424424
425425
Returns the number.
426426
"""
427427
cholesky_instance(a::Number, pivot = DEFAULT_CHOLESKY_PIVOT) = a
428428

429429
"""
430-
cholesky_instance(a::Any, pivot = LinearAlgebra.RowMaximum()) -> cholesky(a, check=false)
430+
cholesky_instance(a::Any, pivot = LinearAlgebra.NoPivot()) -> cholesky(a, check=false)
431431
432432
Slow fallback which gets the instance via factorization. Should get
433433
specialized for new matrix types.

0 commit comments

Comments
 (0)