Update docs

Author: jishnub

docs/src/lib/internals.md

@@ -21,6 +21,8 @@ Pages = ["internals.md"]
 ```@docs
 blockcolsupport
 blockrowsupport
+blockedrange
+BlockedOneTo
 BlockedUnitRange
 BlockRange
 BlockIndexRange

docs/src/man/abstractblockarrayinterface.md

@@ -1,8 +1,8 @@
 # The block axis interface
 
-A block array's block structure is dictated by its axes, which
-are typically a `BlockedUnitRange` but may also be a `UnitRange`, 
-which is assumed to be a single block, or other type that implements
+A block array's block structure is dictated by its axes. These
+are typically `BlockedOneTo`s, but may also be standard and non-blocked `AbstractUnitRange`s
+(which are assumed to correspond to a single block), or other type that implements
 the block axis interface.
 
 

docs/src/man/blockarrays.md

@@ -11,18 +11,18 @@ end
 An `AbstractArray` can be repacked into a `BlockArray` with `BlockArray(array, block_sizes...)`.  The block sizes are each an `AbstractVector{Int}` which determines the size of the blocks in that dimension (so the sum of `block_sizes` in every dimension must match the size of `array` in that dimension).
 
 ```jldoctest
-julia> BlockArray(Array(reshape(1:16, 4, 4)), [2,2], [1,1,2])
+julia> BlockArray(Array(reshape(1:16, 4, 4)), [1,3], [1,1,2])
 2×3-blocked 4×4 BlockMatrix{Int64}:
  1  │  5  │   9  13
- 2  │  6  │  10  14
  ───┼─────┼────────
+ 2  │  6  │  10  14
  3  │  7  │  11  15
  4  │  8  │  12  16
 
 julia> S = spzeros(4,5); S[1,2] = S[4,3] = 1;
 
 julia> block_array_sparse = BlockArray(S, [1,3], [2,3])
-2×2-blocked 4×5 BlockMatrix{Float64, Matrix{SparseMatrixCSC{Float64, Int64}}, Tuple{BlockedUnitRange{Vector{Int64}}, BlockedUnitRange{Vector{Int64}}}}:
+2×2-blocked 4×5 BlockMatrix{Float64, Matrix{SparseMatrixCSC{Float64, Int64}}, Tuple{BlockedOneTo{Vector{Int64}}, BlockedOneTo{Vector{Int64}}}}:
   ⋅   1.0  │   ⋅    ⋅    ⋅ 
  ──────────┼───────────────
   ⋅    ⋅   │   ⋅    ⋅    ⋅ 
@@ -67,7 +67,7 @@ The `block_type` should be an array type.  It specifies the internal block type,
 
 ```jldoctest
 julia> BlockArray(undef_blocks, SparseVector{Float64, Int}, [1,2])
-2-blocked 3-element BlockVector{Float64, Vector{SparseVector{Float64, Int64}}, Tuple{BlockedUnitRange{Vector{Int64}}}}:
+2-blocked 3-element BlockVector{Float64, Vector{SparseVector{Float64, Int64}}, Tuple{BlockedOneTo{Vector{Int64}}}}:
  #undef
  ──────
  #undef
@@ -138,27 +138,36 @@ julia> block_array[1, 2]
 
 To view and modify blocks of `BlockArray` use the `view` syntax.
 ```jldoctest
-julia> A = BlockArray(ones(6), 1:3);
+julia> A = BlockArray([11:16;], 1:3)
+3-blocked 6-element BlockVector{Int64, Vector{Vector{Int64}}, Tuple{BlockedOneTo{ArrayLayouts.RangeCumsum{Int64, UnitRange{Int64}}}}}:
+ 11
+ ──
+ 12
+ 13
+ ──
+ 14
+ 15
+ 16
 
 julia> view(A, Block(2))
-2-element Vector{Float64}:
- 1.0
- 1.0
+2-element Vector{Int64}:
+ 12
+ 13
+
+julia> view(A, Block(2)) .= [3,4];
 
-julia> view(A, Block(2)) .= [3,4]; A[Block(2)]
-2-element Vector{Float64}:
- 3.0
- 4.0
+julia> A[Block(2)]
+2-element Vector{Int64}:
+ 3
+ 4
 
 julia> view(A, Block.(1:2))
-3-element view(::BlockVector{Float64, Vector{Vector{Float64}}, Tuple{BlockedUnitRange{ArrayLayouts.RangeCumsum{Int64, UnitRange{Int64}}}}}, BlockSlice(BlockRange(1:2),1:1:3)) with eltype Float64 with indices 1:1:3:
- 1.0
- 3.0
- 4.0
+3-element view(::BlockVector{Int64, Vector{Vector{Int64}}, Tuple{BlockedOneTo{ArrayLayouts.RangeCumsum{Int64, UnitRange{Int64}}}}}, BlockSlice(BlockRange(1:2),1:1:3)) with eltype Int64 with indices BlockedOneTo([1, 3]):
+ 11
+  3
+  4
 ```
 
-
-
 ## Converting between `BlockArray` and normal arrays
 
 An array can be repacked into a `BlockArray` with `BlockArray(array, block_sizes...)`:
@@ -167,7 +176,7 @@ An array can be repacked into a `BlockArray` with `BlockArray(array, block_sizes
 julia> S = spzeros(4,5); S[1,2] = S[4,3] = 1;
 
 julia> block_array_sparse = BlockArray(S, [1,3], [2,3])
-2×2-blocked 4×5 BlockMatrix{Float64, Matrix{SparseMatrixCSC{Float64, Int64}}, Tuple{BlockedUnitRange{Vector{Int64}}, BlockedUnitRange{Vector{Int64}}}}:
+2×2-blocked 4×5 BlockMatrix{Float64, Matrix{SparseMatrixCSC{Float64, Int64}}, Tuple{BlockedOneTo{Vector{Int64}}, BlockedOneTo{Vector{Int64}}}}:
   ⋅   1.0  │   ⋅    ⋅    ⋅ 
  ──────────┼───────────────
   ⋅    ⋅   │   ⋅    ⋅    ⋅