Mercurial > repos > public > sbplib_julia

comparison src/Grids/equidistant_grid.jl @ 1335:cca45af5e724 refactor/grids

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Some docs for EquidistantGrid
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 03 May 2023 15:49:37 +0200
parents ed3ea0630825
children 760a4a1ec4b7
comparison
equal deleted inserted replaced
1334:47e309eac131 1335:cca45af5e724
1 """ 1 """
2 EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1} 2 EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1}
3 3
4 TODO 4 A one-dimensional equidistant grid. Most users are expected to use
5 [`equidistant_grid`](@ref) for constructing equidistant grids.
6
7 See also: [`equidistant_grid`](@ref)
8
9
10 ## Note
11 The type of range used for the points can likely impact performance.
5 """ 12 """
6 #TODO: Document recomendations for type of range. (LinRange is faster?)
7 struct EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1} 13 struct EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1}
8 points::R 14 points::R
9 end 15 end
10 16
11 Base.eachindex(g::EquidistantGrid) = eachindex(g.points) 17 Base.eachindex(g::EquidistantGrid) = eachindex(g.points)