Skip to content

Commit ebf840c

Browse files
committed
put block docs in a reusable string
1 parent 09d3a82 commit ebf840c

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/uncertainty_interface.jl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -522,16 +522,18 @@ function IntervalArithmetic.Interval(d::δ{C}) where C <: Complex
522522
Complex(re, im)
523523
end
524524

525-
525+
const _blockdocs = """
526+
- `[-N, 0]` denotes a repeated real block of size `N`
527+
- `[N, 0]` denotes a repeated complex block of size `N`
528+
- `[ny, nu]` denotes a full complex block of size `ny × nu`
529+
"""
526530

527531
"""
528532
block_structure(Δ)
529533
530534
Take a vector of uncertain elements and return a vector of vectors with the block
531535
structure of perturbation blocks as described by μ-tools, i.e.
532-
- `[-N, 0]` denotes a repeated real block of size `N`
533-
- `[N, 0]` denotes a repeated complex block of size `N`
534-
- `[ny, nu]` denotes a full complex block of size `ny × nu`
536+
$_blockdocs
535537
"""
536538
function block_structure(D)
537539
perm = sortperm(D, by=d->d.name)
@@ -572,9 +574,7 @@ end
572574
Returns the block structure of `P.Δ` as well as `P.M` permuted according to the sorted block structure.
573575
`blocks` is a vector of vectors with the block
574576
structure of perturbation blocks as described by μ-tools, i.e.
575-
- `[-N, 0]` denotes a repeated real block of size `N`
576-
- `[N, 0]` denotes a repeated complex block of size `N`
577-
- `[ny, nu]` denotes a full complex block of size `ny × nu`
577+
$_blockdocs
578578
"""
579579
function blocksort(P::UncertainSS)
580580
blocks, perm = block_structure(P.Δ)

0 commit comments

Comments
 (0)