Skip to content

Commit 105b420

Browse files
committed
RTree: document ctor for SpatialElem-valued trees
fixes #5
1 parent 49807d9 commit 105b420

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/rtree/rtree.jl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,14 @@ mutable struct RTree{T,N,V} <: SpatialIndex{T,N,V}
125125
end
126126
end
127127

128+
"""
129+
RTree{T,N}([K], V; kwargs...) where {T,N,V}
130+
131+
Construct `N`-dimensional [`RTree`](@ref) object that stores
132+
[`SpatialElem{T,N,K,V}`](@ref `SpatialElem`) elements.
133+
If `K` (the type of spatial element identifier) if not specified,
134+
the stored elements will not have ids.
135+
"""
128136
RTree{T,N}(::Type{V}; kwargs...) where {T,N,V} =
129137
RTree{T,N,SpatialElem{T,N,Nothing,V}}(; kwargs...)
130138

0 commit comments

Comments
 (0)