Mercurial > repos > public > sbplib_julia
changeset 1247:2abec782cf5b refactor/grids
Add todo for EquidistantGrid docs, improve equidistant_grid docs
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Wed, 22 Feb 2023 12:41:14 +0100 |
| parents | 476b889f0ffa |
| children | a5f2372d0e87 |
| files | src/Grids/equidistant_grid.jl |
| diffstat | 1 files changed, 12 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
diff -r 476b889f0ffa -r 2abec782cf5b src/Grids/equidistant_grid.jl --- a/src/Grids/equidistant_grid.jl Wed Feb 22 12:39:42 2023 +0100 +++ b/src/Grids/equidistant_grid.jl Wed Feb 22 12:41:14 2023 +0100 @@ -1,3 +1,7 @@ +""" +# TODO: +""" +#TODO: Document recomendations for type of range. (LinRange is faster?) struct EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1,1} points::R end @@ -77,11 +81,17 @@ `limit_upper`. The length of the domain sides are given by the components of -`limit_upper-limit_lower`. E.g for a 2D grid with `limit_lower=(-1,0)` and `limit_upper=(1,2)` the domain is defined -as `(-1,1)x(0,2)`. The side lengths of the grid are not allowed to be negative. +`limit_upper-limit_lower`. E.g for a 2D grid with `limit_lower=(-1,0)` and +`limit_upper=(1,2)` the domain is defined as `(-1,1)x(0,2)`. The side lengths +of the grid are not allowed to be negative. The number of equidistantly spaced points in each coordinate direction are given by the tuple `size`. + +Note: If `limit_lower` and `limit_upper` are integers and `size` would allow a +completely integer grid, `equidistant_grid` will still return a floating point +grid. This simlifies the implementation and avoids certain surprise +behaviours. """ function equidistant_grid(size::Dims, limit_lower, limit_upper) gs = map(size, limit_lower, limit_upper) do s,l,u