Allow kwargs to pass to lldl (#32)

* Allows kwargs to pass to lldl * Remove spurious "where T" * Add kwargs test * Bump version and compat
JuliaLinearAlgebra · Feb 25, 2023 · c25cf1b · c25cf1b · t-bltg · Mar 9, 2023
1 parent 0a69dc5
commit c25cf1b
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 9 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "Preconditioners"
 uuid = "af69fa37-3177-5a40-98ee-561f696e4fcd"
-version = "0.5.2"
+version = "0.6"
 
 [deps]
 AlgebraicMultigrid = "2169fc97-5a83-5252-b627-83903c6c433c"
@@ -10,7 +10,7 @@ SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
 [compat]
 AlgebraicMultigrid = "0.4, 0.5"
-LimitedLDLFactorizations = "0.4"
+LimitedLDLFactorizations = "0.4, 0.5"
 julia = "1.6"
 
 [extras]

diff --git a/src/incompletecholesky.jl b/src/incompletecholesky.jl
@@ -2,20 +2,30 @@ function assert_pd(d, α)
     @assert α == 0 && all(x -> x > 0, d) "The input matrix is not positive definite."
 end
 
+"""
+    CholeskyPreconditioner(A, memory=2; kwargs...)
+Construct
+`CholeskyPreconditioner` from matrix `A`
+for parameters `memory` and `kwargs` passed to
+`LimitedLDLFactorizations.lldl`.
+"""
 mutable struct CholeskyPreconditioner{L} <: AbstractPreconditioner
     ldlt::L
     memory::Int
-    function CholeskyPreconditioner(A, memory=2)
+    function CholeskyPreconditioner(A, memory=2; kwargs...)
         _A = get_data(A)
-        LLDL = lldl(_A, memory=memory)
+        LLDL = lldl(_A; memory, kwargs...)
         assert_pd(LLDL.D, LLDL.α)
         return new{typeof(LLDL)}(LLDL, memory)
     end
 end
 
-function UpdatePreconditioner!(C::CholeskyPreconditioner, A, memory=C.memory)
+"""
+    UpdatePreconditioner!(C::CholeskyPreconditioner, A, memory=C.memory; kwargs...)
+"""
+function UpdatePreconditioner!(C::CholeskyPreconditioner, A, memory=C.memory; kwargs...)
     _A = get_data(A)
-    LLDL = lldl(_A, memory=memory)
+    LLDL = lldl(_A; memory, kwargs...)
     assert_pd(LLDL.D, LLDL.α)
     C.ldlt = LLDL
     return C

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,7 +1,14 @@
-using LinearAlgebra, SparseArrays, Preconditioners, IterativeSolvers, Random, Test
-using OffsetArrays
+using LinearAlgebra: I, diag, ldiv!, norm, Symmetric, Hermitian
+using SparseArrays: sprand
+using Preconditioners: CholeskyPreconditioner, DiagonalPreconditioner
+using Preconditioners: RugeStuben, SmoothedAggregation
+using Preconditioners: UpdatePreconditioner!, AMGPreconditioner
+using IterativeSolvers: cg
+using Random: seed!
+using Test: @test, @testset, @test_throws
+using OffsetArrays: OffsetMatrix, OffsetVector
 
-Random.seed!(1)
+seed!(1)
 
 function test_matrix(A, F, atol)
     n = size(A, 1)
@@ -10,6 +17,8 @@ function test_matrix(A, F, atol)
         C = CholeskyPreconditioner(A, n)
         @test isapprox(norm(C \ b - Symmetric(A) \ b, Inf), 0.0, atol=atol)
         UpdatePreconditioner!(C, A, 2)
+
+        C2 = CholeskyPreconditioner(A, n; check_tril = true) # check kwargs
     end
     if F === RugeStuben || F === SmoothedAggregation
         p = AMGPreconditioner(F, A)