Statistics: document NaN behavior in Correlation.Pearson/WeightedPearson/Spearman#1155
Open
su-senka wants to merge 1 commit into
Open
Statistics: document NaN behavior in Correlation.Pearson/WeightedPearson/Spearman#1155su-senka wants to merge 1 commit into
su-senka wants to merge 1 commit into
Conversation
…/WeightedPearson/Spearman Pearson, WeightedPearson and Spearman return NaN when one of the input series has zero variance (e.g. fewer than two elements, or all values equal/tied after ranking), since the underlying formula divides by the standard deviation of each series. This was previously undocumented, which led to confusion in mathnet#650. No behavior change; XML doc comments only.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds doc notes to Correlation.Pearson, WeightedPearson, and Spearman clarifying that they return NaN when an input series has zero variance — e.g. too few elements, or all values equal/tied after ranking. Follows up on the discussion in #650, where this behavior was undocumented and caused confusion for a caller computing Spearman on a growing list. Doc-only, no logic changes.