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.

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

Some minor remarks/suggestions on #18 #36

Closed
wants to merge 1 commit into from

Conversation

LasNikas
Copy link
Collaborator

@LasNikas LasNikas commented Jun 25, 2024

Some minor remarks/suggestions on #18

@LasNikas LasNikas requested a review from efaulhaber June 25, 2024 19:09
Copy link

codecov bot commented Jun 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.86%. Comparing base (927120c) to head (6e3ee75).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #36   +/-   ##
=======================================
  Coverage   89.86%   89.86%           
=======================================
  Files          13       13           
  Lines         306      306           
=======================================
  Hits          275      275           
  Misses         31       31           
Flag Coverage Δ
unit 89.86% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines +14 to +22

# Example
```julia
nhs_trivial = TrivialNeighborhoodSearch .......

...

nhs_grid = GridNeighborhoodSearch ....
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't add an example because this benchmark is mostly to be used with plot_benchmarks.

Comment on lines +39 to +40
# Is there a reason why this is hard coded? Why not passing custom nhs like `custom_nhs...`?
# And then `nameof(typeof(nhs))`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. You would have to pass an array of functions (search_radius, coordinates) -> nhs, which would get ugly quickly.
  2. nameof(typeof(nhs)) is not enough. With new backends and options, many of these names will be "SomeNeighborhoodSearch with some_option=true".

I figured it is easier to treat this like an example file that you modify and include again.

@svchb
Copy link
Collaborator

svchb commented Jun 27, 2024

@LasNikas Can we close this?

@LasNikas LasNikas closed this Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants