Document the meaning of seed = 0 in SobolRsg, HaltonRsg and RandomSequenceGenerator - #2738
Merged
Merged
Conversation
|
Thanks for opening this pull request! It might take a while before we look at it, so don't worry if there seems to be no feedback. We'll get to it. |
|
|
|
coverage: 75.308%. remained the same — advitrocks9:document-seed-zero into lballabio:master |
lballabio
changed the title
SobolRsg, HaltonRsg and RandomSequenceGeneratorSobolRsg, HaltonRsg and RandomSequenceGenerator
|
Congratulations on your first merged pull request! |
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
4 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.
Follows up on #2732: adds the missing seed-0 documentation. Comments only, no behaviour change.
SobolRsg,HaltonRsgandRandomSequenceGeneratorall defaultseed = 0and forward it to the RNG without documenting it, while the uniform RNGs carry a note. This adds the same note to all three, with the qualifiers that make it true:SobolRsgonly uses the seed past the tabulated direction integers,HaltonRsgonly whenrandomStartorrandomShiftis true,RandomSequenceGeneratoralways. I checked each case by comparing draws from two generators seeded differently.sobolbrownianbridgersg.hpphas the same gap, left alone because #2691 is open on that file.