Fix builder to use provided rng #150
Merged
Conversation
This file contains 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
This commit fixes the turmoil sim builder by removing the `rng` function. Currently the `build` function ignores the `rng` set on the builder, and due to the boxing of the value there is no easy way to repeatedly build a sim with the same `rng`. We would need to add the ability to clone the boxed rng, which requires some complicated trait bounds and a different breaking of the interface. This is simpler and fixes the bug where rng was ignored during building. This is a breaking change: - `rng` is removed from the builder, as it was not delivering its expected behaviour. Users now need to explicitly specify `build_with_rng`.
mcches
approved these changes
Nov 16, 2023
| pub fn build_with_rng<'a>(&self, rng: Box<dyn RngCore>) -> Sim<'a> { | ||
| /// Build a sim with a provided `rng`. | ||
| /// | ||
| /// This allows setting the random number generator used to fuzz |
There was a problem hiding this comment.
Suggested change
| /// This allows setting the random number generator used to fuzz | |
| /// This allows setting the random number generator used to fuzz. |
cfcosta
reviewed
Nov 17, 2023
| /// Build a sim with a provided `rng`. | ||
| /// | ||
| /// This allows setting the random number generator used to fuzz | ||
| fn build_with_rng<'a>(&self, rng: Box<dyn RngCore>) -> Sim<'a> { |
There was a problem hiding this comment.
Hey, just so you know, the function was public before and isn't anymore, is that by design?
There was a problem hiding this comment.
No, this was a mistake. It should be fixed after #152 is merged
mcches
pushed a commit
that referenced
this pull request
Nov 17, 2023
Add documentation to the sim builder and the config, particularly focused on default values. Also fix a few errors that emerged from running `cargo doc`, and make `build_with_rng` public again (mistake in #150).
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.
This commit fixes the turmoil sim builder by removing the
rngfunction. Currently the
buildfunction ignores therngset on thebuilder, and due to the boxing of the value there is no easy way to
repeatedly build a sim with the same
rng. We would need to add theability to clone the boxed rng, which requires some complicated trait
bounds and a different breaking of the interface. This is simpler and
fixes the bug where rng was ignored during building.
This is a breaking change:
rngis removed from the builder, as it was not delivering itsexpected behaviour. Users now need to explicitly specify
build_with_rng.