Skip to content

Commit 6c4471a

Browse files
committed
Improve docs
1 parent 7f346dc commit 6c4471a

File tree

2 files changed

+24
-19
lines changed

2 files changed

+24
-19
lines changed

REQUIRE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ julia 0.6
22
BandedMatrices 0.4
33
BlockArrays 0.3.1
44
Compat 0.41
5-
FillArrays 0.0.1
5+
FillArrays 0.1

docs/src/index.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,14 @@ For example, if `A` is a `BlockBandedMatrix` with block-bandwidths `(A.l,A.u) ==
3737
and the block sizes `fill(2, N)` where `N = 3` is the number
3838
of row and column blocks, then `A` has zero structure
3939
```julia
40-
[ a_11 a_12
41-
a_21 a_22
42-
a_31 a_32 a_33 a_34
43-
a_41 a_42 a_43 a_44
44-
a_53 a_54
45-
a_63 a_64 ]
40+
[ a_11 a_12 │
41+
a_21 a_22 │
42+
──────────┼──────────
43+
a_31 a_32 │ a_33 a_34
44+
a_41 a_42 │ a_43 a_44
45+
──────────┼──────────
46+
│ a_53 a_54
47+
│ a_63 a_64 ]
4648
```
4749
and is stored in memory via `A.data` as a single vector by columns, containing:
4850
```
@@ -63,22 +65,25 @@ For example, if `A` is a `BandedBlockBandedMatrix` with block-bandwidths `(A.l,A
6365
and subblock-bandwidths `(A.λ, A.μ) == (1,0)`, and the block sizes `fill(2, N)` where `N = 3` is the number
6466
of row and column blocks, then `A` has zero structure
6567
```julia
66-
[ a_11
67-
a_21 a_22
68-
a_31 a_33
69-
a_41 a_42 a_43 a_44
70-
a_53
71-
a_63 a_64 ]
68+
[ a_11
69+
a_21 a_22 │
70+
──────────┼──────────
71+
a_31 │ a_33
72+
a_41 a_42 │ a_43 a_44
73+
──────────┼──────────
74+
│ a_53
75+
│ a_63 a_64 ]
7276
```
7377
and is stored in memory via `A.data` as a `PseudoBlockMatrix`, which has block sizes
7478
2 x 2, containing entries:
79+
```julia
80+
[a_11 a_22 │ a_33 a_44
81+
a_21 × │ a_43 ×
82+
──────────┼──────────
83+
a_31 a_42 │ a_53 a_64
84+
a_41 × │ a_63 × ]
7585
```
76-
[a_11 a_22 a_33 a_44;
77-
a_21 X a_43 X ;
78-
a_31 a_42 a_53 a_64;
79-
a_41 X a_63 X ]
80-
```
81-
where `X` is an entry that is not used.
86+
where `×` is an entry in memory that is not used.
8287

8388
The reasoning behind this storage scheme as that each block still satisfies
8489
the banded matrix interface.

0 commit comments

Comments
 (0)