Merge pull request #23 from putianyi889/patch-1

Vexatos · Dec 24, 2023 · a81ebe9 · a81ebe9
2 parents 1ae9608 + a555c4e
commit a81ebe9
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/CircularArrays.jl b/src/CircularArrays.jl
@@ -28,6 +28,14 @@ Alias for [`CircularArray{T,1,A}`](@ref).
 """
 const CircularVector{T} = CircularArray{T, 1}
 
+"""
+    CircularMatrix{T,A} <: AbstractMatrix{T}
+
+Two-dimensional array backed by an `AbstractArray{T, 2}` of type `A` with fixed size and circular indexing.
+Alias for [`CircularArray{T,2,A}`](@ref).
+"""
+const CircularMatrix{T} = CircularArray{T, 2}
+
 """
     CircularArray(data)