Skip to content

Commit

Permalink
Merge pull request #7 from timholy/patch-1
Browse files Browse the repository at this point in the history
Add "periodic boundary conditions" to README
  • Loading branch information
Vexatos authored Oct 12, 2020
2 parents f00ae95 + 7c537da commit 041d8d3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}`.

Expand Down

0 comments on commit 041d8d3

Please sign in to comment.