SDE Examples: minor rewording of explanation of "diagonal vs non-diagonal noise" #779
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
… SDE examples. I tried to polish the explanation of the diagonal vs non-diagonal noise in SDE examples. In particular, I found it confusing that the function `g` in the code for the diagonal noise returned/modified a vector, while the equally named g in the equation was a matrix. While working on the rewording, I also replaced in the codes the names of in-place functions `f` and `g` with `f!` and `g!`. I hope this will not be found as annoying nitpicking.
hurak
changed the title
ChrisRackauckas
approved these changes
May 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I tried to polish the explanation of the diagonal vs non-diagonal noise in SDE examples. In particular, I found it confusing that the function
gin the code for the diagonal noise returned/modified a vector, while the equally named g in the equation was a matrix. That the function implicitly returns/modifies a diagonal of the matrix was a fact that could have escaped one's attention. I do confirm that it was stated in the documentation but I just tried to emphasise it even more.While working on the rewording, I also replaced in the codes the names of in-place functions
fandgwithf!andg!. I hope this will not be found as annoying nitpicking. As I am checking other examples in DifferentialEquations.jl, while some obviously follow this convention, majority does not.