Skip to content

Commit cbd8f42

Browse files
committed
Improve docstring of search methods
1 parent 6630ef7 commit cbd8f42

File tree

2 files changed

+34
-25
lines changed

2 files changed

+34
-25
lines changed

docs/src/algorithms/neighborsearch.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ point of reference. This can be performed with search methods:
1010

1111
```@docs
1212
NeighborSearchMethod
13+
BoundedNeighborSearchMethod
1314
search
1415
search!
1516
searchdists

src/neighborsearch.jl

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,53 +10,61 @@ A method for searching neighbors given a reference point.
1010
abstract type NeighborSearchMethod end
1111

1212
"""
13-
search!(neighbors, pₒ, method; mask=nothing)
13+
search(pₒ, method, mask=nothing)
1414
15-
Update `neighbors` of point `pₒ` using `method` and return
16-
number of neighbors found. Optionally, specify a `mask` for
17-
all indices of the domain.
15+
Return neighbors of point `pₒ` using `method`. Optionally,
16+
specify a `mask` for all indices of the domain.
1817
"""
19-
function search! end
18+
function search end
2019

2120
"""
22-
searchdists!(neighbors, distances, pₒ, method; mask=nothing)
21+
BoundedNeighborSearchMethod
2322
24-
Update `neighbors` and `distances` of point `pₒ` using `method`
25-
and return number of neighbors found. Optionally, specify a
26-
`mask` for all indices of the domain.
23+
A method for searching neighbors with the property that the number of neighbors
24+
is bounded above by a known constant (e.g. k-nearest neighbors).
2725
"""
28-
function searchdists! end
26+
abstract type BoundedNeighborSearchMethod <: NeighborSearchMethod end
2927

3028
"""
31-
search(pₒ, method, mask=nothing)
29+
maxneighbors(method)
3230
33-
Return neighbors of point `pₒ` using `method`. Optionally,
34-
specify a `mask` for all indices of the domain.
31+
Return the maximum number of neighbors obtained with bounded search `method`.
32+
33+
See [`BoundedNeighborSearchMethod`](@ref) for additional details.
3534
"""
36-
function search end
35+
function maxneighbors end
3736

3837
"""
39-
searchdists(pₒ, method, mask=nothing)
38+
search!(neighbors, pₒ, method; mask=nothing)
4039
41-
Return neighbors and distances of point `pₒ` using `method`.
42-
Optionally, specify a `mask` for all indices of the domain.
40+
Update `neighbors` of point `pₒ` using bounded search `method` and return
41+
number of neighbors found. Optionally, specify a `mask` for all indices of
42+
the domain.
43+
44+
See [`BoundedNeighborSearchMethod`](@ref) for additional details.
4345
"""
44-
function searchdists end
46+
function search! end
4547

4648
"""
47-
BoundedNeighborSearchMethod
49+
searchdists!(neighbors, distances, pₒ, method; mask=nothing)
4850
49-
A method for searching neighbors with the property that the number of neighbors
50-
is bounded above by a known constant (e.g. k-nearest neighbors).
51+
Update `neighbors` and `distances` of point `pₒ` using bounded search `method`
52+
and return number of neighbors found. Optionally, specify a `mask` for all
53+
indices of the domain.
54+
55+
See [`BoundedNeighborSearchMethod`](@ref) for additional details.
5156
"""
52-
abstract type BoundedNeighborSearchMethod <: NeighborSearchMethod end
57+
function searchdists! end
5358

5459
"""
55-
maxneighbors(method)
60+
searchdists(pₒ, method, mask=nothing)
5661
57-
Return the maximum number of neighbors obtained with `method`.
62+
Return neighbors and distances of point `pₒ` using bounded search `method`.
63+
Optionally, specify a `mask` for all indices of the domain.
64+
65+
See [`BoundedNeighborSearchMethod`](@ref) for additional details.
5866
"""
59-
function maxneighbors end
67+
function searchdists end
6068

6169
# ----------
6270
# FALLBACKS

0 commit comments

Comments
 (0)