From 7c537da7cff4efc3566480d08ef08270f6d94b0b Mon Sep 17 00:00:00 2001 From: Tim Holy Date: Mon, 12 Oct 2020 08:22:39 -0500 Subject: [PATCH] Add "periodic boundary conditions" to README This is the term I searched for on juliahub but didn't discover this package. I thought adding it to the README might help. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6dd44e9..339f207 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![codecov](https://codecov.io/gh/Vexatos/CircularArrays.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/Vexatos/CircularArrays.jl) [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://pkg.julialang.org/docs/CircularArrays/) -CircularArrays.jl is a small package adding the `CircularArray` type which can be backed by any `AbstractArray`. A `CircularArray{T,N,A}` is an `AbstractArray{T,N}` backed by a data array of type `A`. It has a fixed size and features circular indexing across all dimensions: Indexing and assigning beyond its bounds in both directions is possible, as the end of the array is considered adjacent to its start. `CircularArray`s have the same `axes` as the underlying backing array, and iterators only iterate over these indices. +CircularArrays.jl is a small package adding the `CircularArray` type which can be backed by any `AbstractArray`. A `CircularArray{T,N,A}` is an `AbstractArray{T,N}` backed by a data array of type `A`. It has a fixed size and features circular indexing (periodic boundary conditions) across all dimensions: Indexing and assigning beyond its bounds in both directions is possible, as the end of the array is considered adjacent to its start. `CircularArray`s have the same `axes` as the underlying backing array, and iterators only iterate over these indices. The `CircularVector{T}` type is added as an alias for `CircularArray{T, 1}`.