From e960a8b4987aa1fd7fc68e3a22d3e34a580c73cf Mon Sep 17 00:00:00 2001 From: "Tamas K. Papp" Date: Wed, 23 Sep 2020 16:05:14 +0200 Subject: [PATCH 1/2] document OffsetVector and OffsetMatrix --- src/OffsetArrays.jl | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/OffsetArrays.jl b/src/OffsetArrays.jl index fd7cc562..aae5e3b1 100644 --- a/src/OffsetArrays.jl +++ b/src/OffsetArrays.jl @@ -97,7 +97,19 @@ struct OffsetArray{T,N,AA<:AbstractArray} <: AbstractArray{T,N} new{T, N, AA}(parent, offsets) end end + +""" + OffsetVector(v, index) + +Type alias and convenience constructor for one-dimensional [`OffsetArray`](@ref)s. +""" const OffsetVector{T,AA<:AbstractArray} = OffsetArray{T,1,AA} + +""" + OffsetMatrix(A, index1, index2) + +Type alias and convenience constructor for two-dimensional [`OffsetArray`](@ref)s. +""" const OffsetMatrix{T,AA<:AbstractArray} = OffsetArray{T,2,AA} function overflow_check(r, offset::T) where T From eac0bcbf1ad30a7250ea9dfc2585de1e9ffcae36 Mon Sep 17 00:00:00 2001 From: "Tamas K. Papp" Date: Wed, 23 Sep 2020 16:06:29 +0200 Subject: [PATCH 2/2] add to generated docs --- docs/src/reference.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/reference.md b/docs/src/reference.md index 500ad5f8..2d17f596 100644 --- a/docs/src/reference.md +++ b/docs/src/reference.md @@ -2,6 +2,8 @@ ```@docs OffsetArray +OffsetVector +OffsetMatrix OffsetArrays.Origin OffsetArrays.IdOffsetRange OffsetArrays.no_offset_view