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

Make cov and cor similar to mean and var by removing keyword arguments. #13465

Merged
merged 1 commit into from
Oct 8, 2015

Conversation

andreasnoack
Copy link
Member

This fixes #13081 and the type instability that motivated that issue.

I think it is actually quite rare that users would like to provide a precalculated mean and when they do, they would like maximum performance which they wouldn't get from a keyword argument function anyway. Since precalculated means are rare, I have also chosen not to export covm and corm.

It is probably more likely that someone would like the uncorrected version of the covariance, but it is not hard to get without the keyword argument.

The dimension keyword is simply too inconsistent with what we are doing for mean, var, sum etc.

I've also moved the documentation to the method definitions and split it out on the individual methods.

@andreasnoack
Copy link
Member Author

By the way, when updating the tests to the new signatures, I realized that cov and cor are not really that extensively tested for numerical accuracy. The tests are mainly testing that all the dispatch is working.

This fixes #13081 and the type instability that motivated that issue.
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.

cor, cov: remove mean keyword arg
1 participant