fix: Potentially undefined behaviour when initialised with invalid probability distribution. - #16
Open
webbrain-one wants to merge 1 commit into
Open
fix: Potentially undefined behaviour when initialised with invalid probability distribution.#16webbrain-one wants to merge 1 commit into
webbrain-one wants to merge 1 commit into
Conversation
Add a check during initialization to ensure the distribution sums to 1. This prevents undefined behavior when the sampler is initialized with an invalid probability distribution. Closes asmith26#7
|
|
||
| def __init__(self, dist, rng=None): | ||
| """ (VoseAlias, dict[, RNG]) -> NoneType """ | ||
| if sum(dist.values()) != 1: |
Contributor
There was a problem hiding this comment.
I recommend checking if the sum is close to 1 instead of exactly 1, since we are summing floats, which is unlikely except in simple cases to actually add to exactly 1. See math.isclose(): https://docs.python.org/3/library/math.html#math.isclose
Owner
There was a problem hiding this comment.
Thanks for the review @austin-bowen, this sounds good to me!
Thanks very much also @webbrain-one for this addition! Should be good to merge once this is added - I've also just added automated checks/GitHub Actions in #17, so you may need to merge main to pick these up.
Thanks again!
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
3 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.
Closes #7