Skip to content

Commit 069e900

Browse files
committed
Add more references to the in-place methods
1 parent 3a2fa92 commit 069e900

File tree

2 files changed

+76
-145
lines changed

2 files changed

+76
-145
lines changed

src/block_krylov_workspaces.jl

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@ export BlockKrylovWorkspace, BlockMinresWorkspace, BlockGmresWorkspace
44
abstract type BlockKrylovWorkspace{T,FC,SV,SM} end
55

66
"""
7-
Type for storing the vectors required by the in-place version of BLOCK-MINRES.
7+
Workspace for the in-place method [`block_minres!`](@ref).
88
9-
The outer constructors
9+
The following outer constructors can be used to initialize this workspace:
1010
1111
workspace = BlockMinresWorkspace(m, n, p, SV, SM)
1212
workspace = BlockMinresWorkspace(A, B)
13-
14-
may be used in order to create these vectors.
1513
"""
1614
mutable struct BlockMinresWorkspace{T,FC,SV,SM} <: BlockKrylovWorkspace{T,FC,SV,SM}
1715
m :: Int
@@ -70,14 +68,13 @@ function BlockMinresWorkspace(A, B)
7068
end
7169

7270
"""
73-
Type for storing the vectors required by the in-place version of BLOCK-GMRES.
71+
Workspace for the in-place method [`block_gmres!`](@ref).
7472
75-
The outer constructors
73+
The following outer constructors can be used to initialize this workspace:
7674
7775
workspace = BlockGmresWorkspace(m, n, p, SV, SM; memory = 5)
7876
workspace = BlockGmresWorkspace(A, B; memory = 5)
7977
80-
may be used in order to create these vectors.
8178
`memory` is set to `div(n,p)` if the value given is larger than `div(n,p)`.
8279
"""
8380
mutable struct BlockGmresWorkspace{T,FC,SV,SM} <: BlockKrylovWorkspace{T,FC,SV,SM}

0 commit comments

Comments
 (0)