Odometex v0.1.0 Odometex View Source

Provides simple comparisons with global references given a distance.

Link to this section Summary

Functions

Returns a list of results with the number of times of each one

Link to this section Functions

Link to this function compare(distance, options \\ []) View Source

Returns a list of results with the number of times of each one.

It could take some options:

  • order: You can use three different orders:

    • best_match: Returns the results such distance comparison (times) tends to 1.
    • asc: Returns the results given the shortest distances that we have as references.
    • desc: Returns the results given the longest distances that we have as references.
  • limit: The number of results to retunr. Default 5.

Examples

iex> Odometex.compare(20) [

%Odometex.Result{label: "Bowling lane", meters: 19, times: 1.052632},
%Odometex.Result{label: "Blue Whale (female)", meters: 25, times: 0.8},
%Odometex.Result{label: "Basketball court", meters: 28, times: 0.714286},
%Odometex.Result{label: "Football pitch", meters: 105, times: 0.190476},
%Odometex.Result{
  label: "Passeig de Gràcia, Barcelona",
  meters: 1300,
  times: 0.015385
}

]

iex> Odometex.compare(20, order: :desc, limit: 1) [

%Odometex.Result{label: "Great Wall", meters: 8851000, times: 2.0e-6}

]