Skip to content

Commit a111211

Browse files
committed
Update docs
1 parent 951afcd commit a111211

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
*Block arrays in Julia*
44

5-
[![Build Status](https://travis-ci.org/KristofferC/BlockArrays.jl.svg?branch=master)](https://travis-ci.org/KristofferC/BlockArrays.jl) [![codecov](https://codecov.io/gh/KristofferC/BlockArrays.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/KristofferC/BlockArrays.jl)
5+
[![Build Status](https://travis-ci.org/JuliaArrays/BlockArrays.jl.svg?branch=master)](https://travis-ci.org/JuliaArrays/BlockArrays.jl) [![codecov](https://codecov.io/gh/JuliaArrays/BlockArrays.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaArrays/BlockArrays.jl)
66

77
A block array is a partition of an array into blocks or subarrays, see [wikipedia](https://en.wikipedia.org/wiki/Block_matrix) for a more extensive description. This package has two purposes. Firstly, it defines an interface for an `AbstractBlockArray` block arrays that can be shared among types representing different types of block arrays. The advantage to this is that it provides a consistent API for block arrays.
88

docs/src/man/abstractblockarrayinterface.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ In order to follow the `AbstractBlockSizes` the following methods should be impl
1414
# The `AbstractBlockArray` interface
1515

1616
| Methods to implement | Brief description |
17+
| :---------------------- | :---------------- |
1718
| `blocksizes(A)` | Return a subtype of `AbstractBlockSizes` |
18-
| **Optional methods** | |
19+
| **Optional methods** |
1920
| `getblock(A, i...)` | `X[Block(i...)]`, blocked indexing |
2021
| `setblock!(A, v, i...)` | `X[Block(i...)] = v`, blocked index assignment |
2122
| `getblock!(x, A, i)` | `X[i]`, blocked index assignment with in place storage in `x` |

docs/src/man/blockarrays.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ An alternative syntax for this is `block_array[Block(i...)] = v` or
5656
`block_array[Block.(i)...]`.
5757

5858
```jldoctest
59-
julia> block_array = BlockArray{Float64}(unitialized_blocks, [1,2], [2,2])
59+
julia> block_array = BlockArray{Float64}(undef_blocks, [1,2], [2,2])
6060
2×2-blocked 3×4 BlockArrays.BlockArray{Float64,2,Array{Float64,2}}:
6161
#undef #undef │ #undef #undef
6262
----------------┼----------------

src/blockarray.jl

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ array-constructor-caller would like an uninitialized block array. See also
1414
undef_blocks (@ref), an alias for UndefBlocksInitializer().
1515
1616
Examples
17-
≡≡≡≡≡≡≡≡≡≡
1817
18+
≡≡≡≡≡≡≡≡≡≡
19+
```julia
1920
julia> BlockArray(undef_blocks, Matrix{Float32}, [1,2], [3,2])
2021
2×2-blocked 3×5 BlockArrays.BlockArray{Float32,2,Array{Float32,2}}:
2122
#undef #undef #undef │ #undef #undef
2223
------------------------┼----------------
2324
#undef #undef #undef │ #undef #undef
2425
#undef #undef #undef │ #undef #undef
26+
```
2527
"""
2628
struct UndefBlocksInitializer end
2729

@@ -33,14 +35,16 @@ type UndefBlocksInitializer (@ref), used in block array initialization to indica
3335
array-constructor-caller would like an uninitialized block array.
3436
3537
Examples
36-
≡≡≡≡≡≡≡≡≡≡
3738
39+
≡≡≡≡≡≡≡≡≡≡
40+
```julia
3841
julia> BlockArray(undef_blocks, Matrix{Float32}, [1,2], [3,2])
3942
2×2-blocked 3×5 BlockArrays.BlockArray{Float32,2,Array{Float32,2}}:
4043
#undef #undef #undef │ #undef #undef
4144
------------------------┼----------------
4245
#undef #undef #undef │ #undef #undef
4346
#undef #undef #undef │ #undef #undef
47+
```
4448
"""
4549
const undef_blocks = UndefBlocksInitializer()
4650

0 commit comments

Comments
 (0)