[ENH] Improved the test coverage of similarity search module

[lucifer4073]

Enhancement: Expand Test Coverage for Similarity Search Module #2022.

Summary:

This pull request enhances the test coverage for the similarity search module by introducing new test cases and addressing specific functionalities.

Added Test Cases:

1. _commons.py Functions:

   • extract_top_k_and_threshold_from_distance_profiles
   • numba_roll_2D_no_warparound
   • numba_roll_1D_no_warparound

2. Query Search:

   • Validation of the apply_exclusion parameter.

3. SeriesSearch:

   • Handling of equal length sequences.
   • Evaluation of the inverse_distance parameter.

Additional Consideration:

The test for the function test_SeriesSearch_apply_exclusion has not been included due to the issues detailed in #2475.

References:

• [ENH] Improve test coverage of similarity search module #2022
• [BUG] extract_top_k_and_threshold_from_distance_profiles_one_series Function Errors Related to Numba and n_candidates Parameter #2475

[aeon-actions-bot]

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#FEF1BE}{\textsf{enhancement}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#006b75}{\textsf{similarity search}}$ ]. Feel free to change these if they do not properly represent the PR.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

• Run pre-commit checks for all files
• Run mypy typecheck tests
• Run all pytest tests and configurations
• Run all notebook example tests
• Run numba-disabled codecov tests
• Stop automatic pre-commit fixes (always disabled for drafts)
• Disable numba cache loading
• Push an empty commit to re-run CI checks

[lucifer4073]

@all-contributors please add @lucifer4073 for code

[allcontributors]

@lucifer4073

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

[baraline]

Hi @lucifer4073, to be fair with a previous PR, i'm going to make the same comment as I did in #2472:

I'm making major modifications to the module in #2473, including a fix (hopefully) for the issue you identified with the extract top k function. I'm gonna make you the same proposition as #2472, which is to close this PR and hold contribution to this module until #2473 is in. After that, you can do a similar contribution for the test coverage of the module, as I'm sure I will not get to 100% on #2473.

If you are OK with this I'll tag you in the original issue with the code coverage report so you know on what function you could add tests.

[lucifer4073]

Hi @baraline, thanks for the communication. I would appreciate if you can mention this PR in #2473. Once #2473 is merged and if anything is remaning to be addressed in the similarity search module, we can refer this PR.

Until then you may close this PR.