Skip to content

Commit

Permalink
Improve docs for plot_benchmarks (#39)
Browse files Browse the repository at this point in the history
Co-authored-by: Niklas Neher <73897120+LasNikas@users.noreply.github.com>
  • Loading branch information
efaulhaber and LasNikas authored Jun 26, 2024
1 parent caa3d4e commit 0808ec1
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion benchmarks/plot.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ include("../test/point_cloud.jl")
seed = 1, perturbation_factor_position = 1.0,
parallel = true, title = "")
Run a benchmark for with several neighborhood searches multiple times for increasing numbers
Run a benchmark with several neighborhood searches multiple times for increasing numbers
of points and plot the results.
# Arguments
Expand All @@ -28,6 +28,12 @@ of points and plot the results.
- `perturbation_factor_position = 1.0`: Perturb point positions by this factor. A factor of
`1.0` corresponds to points being moved by
a maximum distance of `0.5` along each axis.
# Examples
```julia
include("benchmarks/benchmarks.jl")
plot_benchmarks(benchmark_count_neighbors, (10, 10), 3)
"""
function plot_benchmarks(benchmark, n_points_per_dimension, iterations;
parallel = true, title = "",
Expand Down

0 comments on commit 0808ec1

Please sign in to comment.