Ouranosinc / xsdba / 15741065418

78%

push

github

Clip bounds additive space (#165)

<!-- Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
  - This PR fixes #xyz
- [ ] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [x] (If applicable) Tests have been added.
- [x] CHANGELOG.rst has been updated (with summary of main changes).
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added.

### What kind of change does this PR introduce?

* Additive_space defines `lower_bound` and possible `upper_bound`.
`data` should be $low < data < high$, else infinities arise. It
sometimes happens we have $low \leq data \leq high$ (e.g. hurs at
exactly 100%). For convenience, to_additive_space can now transform
$data \in [low, high] \to ]low, high[$ by adding/subtracting the
smallest float32 increments. If `data < low | data > high` this throws
an error if we try this procedure. We don't want the clipping to put
problems under the rug

### Does this PR introduce a breaking change?

No

### Other information:

@juliettelavoie I think it makes sense to have this directly in xsdba.
Here, I don't specify any clipping bounds, I think it's better to just
use whatever {lower,upper}_bound are given

In this way, xscen could simply set `clip_to_bounds = True` in the
arguments of `to_additive_space`

5 of 6 new or added lines in 1 file covered. (83.33%)

2734 of 3518 relevant lines covered (77.71%)

5.32 hits per line