Skip to content

Commit

Permalink
Update the docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
amontoison committed Dec 3, 2023
1 parent a683aec commit bdd7c95
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions src/interfaces.jl
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ mutable struct CudssSolver
end

"""
cudss_set(matrix::CudssMatrix, A::CuVector)
cudss_set(matrix::CudssMatrix, A::CuMatrix)
cudss_set(matrix::CudssMatrix, A::CuSparseMatrixCSR)
cudss_set(matrix::CudssMatrix, A::CuVector)
cudss_set(matrix::CudssMatrix, A::CuMatrix)
cudss_set(matrix::CudssMatrix, A::CuSparseMatrixCSR)
cudss_set(config::CudssConfig, param::String, value)
cudss_set(config::CudssConfig, param::String, value)
The available config parameters are:
"reordering_alg"
Expand All @@ -37,7 +37,7 @@ The available config parameters are:
"pivot_epsilon"
"max_lu_nnz"
cudss_set(data::CudssData, param::String, value)
cudss_set(data::CudssData, param::String, value)
The available data parameters are:
"info"
Expand Down Expand Up @@ -79,7 +79,7 @@ function cudss_set(config::CudssConfig, param::String, value)
end

"""
value = cudss_get(config::CudssConfig, param::String)
value = cudss_get(config::CudssConfig, param::String)
The available config parameters are:
"reordering_alg"
Expand All @@ -94,7 +94,7 @@ The available config parameters are:
"pivot_epsilon"
"max_lu_nnz"
value = cudss_get(data::CudssData, param::String)
value = cudss_get(data::CudssData, param::String)
The available data parameters are:
"info"
Expand Down Expand Up @@ -128,9 +128,9 @@ function cudss_get(config::CudssConfig, param::String)
end

"""
cudss(phase::String, solver::CudssSolver, x::CuVector, b::CuVector)
cudss(phase::String, solver::CudssSolver, X::CuMatrix, B::CuMatrix)
cudss(phase::String, solver::CudssSolver, X::CudssMatrix, B::CudssMatrix)
cudss(phase::String, solver::CudssSolver, x::CuVector, b::CuVector)
cudss(phase::String, solver::CudssSolver, X::CuMatrix, B::CuMatrix)
cudss(phase::String, solver::CudssSolver, X::CudssMatrix, B::CudssMatrix)
The available phases are "analysis", "factorization", "refactorization" and "solve".
The phases "solve_fwd", "solve_diag" and "solve_bwd" are available but not yet functional.
Expand Down

0 comments on commit bdd7c95

Please sign in to comment.