Skip to content

DOC: note the covariance of GaussianChiEffChiP - #150

Merged
ColmTalbot merged 1 commit into
mainfrom
chi-eff-chi-p-covariance-doc
Oct 23, 2026
Merged

ColmTalbot merged 1 commit into
mainfrom
chi-eff-chi-p-covariance-doc

Conversation

@ColmTalbot

Copy link
Copy Markdown
Owner

unnormalized_2d_gaussian divides the quadratic form by (1 - rho) rather than (1 - rho^2), so the covariance matrix is Sigma / (1 + rho): the correlation coefficient is rho, but the standard deviations are sigma / sqrt(1 + rho), e.g., twice sigma for rho = -0.75. Note this in the docstrings of unnormalized_2d_gaussian and GaussianChiEffChiP; the behaviour is unchanged.

unnormalized_2d_gaussian divides the quadratic form by (1 - rho) rather
than (1 - rho^2), so the covariance matrix is Sigma / (1 + rho): the
correlation coefficient is rho, but the standard deviations are
sigma / sqrt(1 + rho), e.g., twice sigma for rho = -0.75. Note this in
the docstrings of unnormalized_2d_gaussian and GaussianChiEffChiP; the
behaviour is unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Oct 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.12%. Comparing base (4da2034) to head (9a7924d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #150   +/-   ##
=======================================
  Coverage   95.12%   95.12%           
=======================================
  Files          14       14           
  Lines        1085     1085           
=======================================
  Hits         1032     1032           
  Misses         53       53           
Flag Coverage Δ
python3.10 95.12% <ø> (ø)
python3.11 95.12% <ø> (ø)
python3.12 95.12% <ø> (ø)
python3.13 95.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ColmTalbot
ColmTalbot merged commit 29c1f31 into main Oct 23, 2026
9 checks passed
@ColmTalbot
ColmTalbot deleted the chi-eff-chi-p-covariance-doc branch October 23, 2026 18:20
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.

1 participant