Support batch 1-d convolution in `ht.signal.convolve`

[ClaudiaComito]

Due Diligence

• General:
  • [x] title of the PR is suitable to appear in the Release Notes
• Implementation:
  • [x] unit tests: all split configurations tested
  • [x] unit tests: multiple dtypes tested
  • [x] documentation updated where needed

Description

This PR expands ht.signal.convolve to perform 1-D convolutions on a batch of 1-D arrays, i.e.

• if signal.shape = (..., n) and kernel.shape = (m,): signal's last dimension will be convolved with kernel.

• if e.g. signal.shape = (i, j, n) and kernel.shape = (i, j, m,): each element signal[i, j] of size n will be convolved with the corresponding element kernel[i,j] of size m.

• Signal and kernel can be any number of dimensions, as long as the batch dimensions match.

• Signal and kernel can be distributed along any of the batch dimensions.

Issue/s resolved: #1514 Related: #1396

Changes proposed:

• enable batch 1-D convolution
• expand documentation, examples
• expand tests

Type of change

• New feature (non-breaking change which adds functionality)

Memory requirements

Performance

Does this change modify the behaviour of other functions? If so, which?

yes, instead of returning ValueError when signal is n-D, ht.convolve now raises a ValueError only if batch convolution isn't possible (shapes mismatch, unsuitable distribution)

[github-actions[bot]]

Thank you for the PR!

[github-actions[bot]]

Thank you for the PR!

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.89%. Comparing base (064f495) to head (332ae51). Report is 239 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #1515 +/- ## ========================================== + Coverage 91.85% 91.89% +0.03% ========================================== Files 80 80 Lines 11878 11916 +38 ========================================== + Hits 10911 10950 +39 + Misses 967 966 -1 ``` | [Flag](https://app.codecov.io/gh/helmholtz-analytics/heat/pull/1515/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=helmholtz-analytics) | Coverage Δ | | |---|---|---| | [unit](https://app.codecov.io/gh/helmholtz-analytics/heat/pull/1515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=helmholtz-analytics) | `91.89% <100.00%> (+0.03%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=helmholtz-analytics#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[github-actions[bot]]

Thank you for the PR!

[github-actions[bot]]

Thank you for the PR!

[github-actions[bot]]

Thank you for the PR!

[ClaudiaComito]

@JuanPedroGHM @krajsek @mrfh92 thanks for reviewing, I think I addressed all points, let me know if something's missing.