Fix mean_second_derivative_central docstring formula (was double the computed value) - #1131
Open
AlejandroCoronadoN wants to merge 1 commit into
Open
Fix mean_second_derivative_central docstring formula (was double the computed value)#1131AlejandroCoronadoN wants to merge 1 commit into
AlejandroCoronadoN wants to merge 1 commit into
Conversation
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
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.
The
mean_second_derivative_centraldocstring's LaTeX formula does not match what the function computes. The formula carries an extra inner factor of1/2, so the documented expression evaluates to exactly half of the returned value.For
x = [1, 3, 7, -3]the function returns-3.0(asserted intest_feature_calculations.py), while the docstring's formula evaluates to-1.5.The code is correct and covered by that test; only the docstring is stale. The extra
1/2is a leftover from the 2019 refactor (#587) that rewrote the outer denominator to1/(2(n-2))but left the old inner1/2in place. This removes the redundant1/2and tightens the sum's upper index fromn-1ton-2, the number of valid central-difference terms.