Skip to content

Latest commit

 

History

History
64 lines (54 loc) · 1.3 KB

index.md

File metadata and controls

64 lines (54 loc) · 1.3 KB

Public API

Neighborhood.jl is a Julia package that provides a unified interface for doing neighbor searches in Julia. This interface is described in this page.

Search Structures

searchstructure

All currently supported search structures are:

using Neighborhood # hide
for ss in Neighborhood.SSS # hide
    println(ss) # hide
end # hide

The following functions are defined for search structures:

Neighborhood.datatype
Neighborhood.getmetric

Search functions

search
isearch
inrange
inrangecount
knn

Search types

SearchType
WithinRange
NeighborNumber

Bulk searches

Some packages support higher performance when doing bulk searches (instead of individually calling search many times).

bulksearch
bulkisearch

Brute force searches

The BruteForce "search structure" performs a linear search through its data array, calculating the distance from the query to each data point. This is the slowest possible implementation but can be used to check results from other search structures for correctness. The Neighborhood.bruteforcesearch function can be used instead without having to create the search structure.

Neighborhood.bruteforcesearch
BruteForce

Theiler window

Theiler