Throw an error when passing empty input to cov
#93
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
74897fe unintentionnally changed the behavior of `cov`, which now allows passing two empty vectors instead of throwing an error. This is inconsistent with `cor`. If we wanted to return a value, `NaN` would be more appropriate and consistent with `var`, but for now make this an error again. Also add tests to cover all empty inputs for similar functions. Unfortunately it turns out we are quite inconsistent already, as `cor` and `cov` allow empty matrices already, but `cov` returns `-0.0` while `cor`, `std` and `var` return `NaN`.
Codecov Report
@@ Coverage Diff @@
## master #93 +/- ##
==========================================
+ Coverage 96.89% 96.91% +0.02%
==========================================
Files 1 1
Lines 419 422 +3
==========================================
+ Hits 406 409 +3
Misses 13 13
Continue to review full report at Codecov.
|
bkamins
approved these changes
Oct 26, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://github.com/JuliaLang/Statistics.jl/pull/85 unintentionnally changed the behavior of
cov, which now allows passing two empty vectors instead of throwing an error. This is inconsistent withcor. If we wanted to return a value,NaNwould be more appropriate and consistent withvar, but for now make this an error again.Also add tests to cover all empty inputs for similar functions. Unfortunately it turns out we are quite inconsistent already, as
corandcovallow empty matrices already, butcovreturns-0.0whilecor,stdandvarreturnNaN.This change should be backported to Julia 1.7 before it is released to avoid breaking code if we do it later.