update documentation for qrm_refine

JuliaSmoothOptimizers · Nov 22, 2024 · 19cc2f8 · 19cc2f8
1 parent 5d3fa54
commit 19cc2f8
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -48,6 +48,8 @@ qrm_least_squares
 qrm_least_squares!
 qrm_min_norm
 qrm_min_norm!
+qrm_refine
+qrm_refine!
 ```
 
 ```@docs

diff --git a/src/QRMumps.jl b/src/QRMumps.jl
@@ -421,16 +421,16 @@ function qrm_residual_orth end
 @doc raw"""
     qrm_refine!(spmat, spfct, x, z, Δx, y)
 
-Given an approximate solution x of the linear system RᵀRx ≈ z where R is the R-factor of some QR factorization, compute a refined solution.
+Given an approximate solution x of the linear system RᵀRx ≈ z where R is the R-factor of some QR factorization of size (m, n), compute a refined solution.
 
 ### Input Arguments :
 
 * `spmat`: the input matrix.
 * `spfct`: a sparse factorization object of type `qrm_spfct`.
-* `x`: the approximate solution vector.
-* `z`: the RHS vector of the linear system.
-* `Δx`: an auxiliary vector with the same size as `x` used to compute the refinement. 
-* `y`: an auxiliary vector with the same size as the number `Rx` used to compute the refinement.
+* `x`: the approximate solution vector, the size of this vector is n.
+* `z`: the RHS vector of the linear system, the size of this vector is n.
+* `Δx`: an auxiliary vector used to compute the refinement, the size of this vector is n.
+* `y`: an auxiliary vector used to compute the refinement, the size of this vector is m.
 """
 function qrm_refine! end
 

diff --git a/src/utils.jl b/src/utils.jl
@@ -1,4 +1,3 @@
-# Given an approximate solution x of the system RᵀRx ≈ z, refine the solution
 function qrm_refine(spmat :: qrm_spmat{T}, spfct :: qrm_spfct{T}, x :: AbstractVector{T}, z :: AbstractVector{T}) where T
   Δx = similar(x)
   y = similar(x, spfct.fct.m)