Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve docs for plot_benchmarks #39

Merged
merged 2 commits into from
Jun 26, 2024
Merged

Improve docs for plot_benchmarks #39

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d0a3f9
Improve docs for `plot_benchmarks`
efaulhaber Jun 26, 2024
dea1396
Merge branch 'main' into ef/docs-plot-benchmarks
LasNikas Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion benchmarks/plot.jl
View file
Open in desktop
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