Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecate RandomGenM in favor of a more powerful FrozenGen #149

Merged
merged 4 commits into from
Nov 24, 2023
Merged

Deprecate RandomGenM in favor of a more powerful FrozenGen #149

merged 4 commits into from
Nov 24, 2023

Conversation

lehins
Copy link
Contributor

@lehins lehins commented Oct 28, 2023 •
edited
Loading

  • Addition of modifyGen totally removes the need for RandomGenM, because every frozen generator that is a netwtype wrapper around RandomGen also derives an instance for RandomGen
  • Add splitMutableGen and splitGen
  • Add ThawedGen and move thawGen into that type class to combat current unlawful FrozenGen instance for StateGen

@lehins lehins mentioned this pull request Oct 28, 2023
Closed
@lehins lehins force-pushed the lehins/extend-frozen-gen branch 5 times, most recently from 618b5e4 to 2fba77c Compare October 29, 2023 20:19
@lehins lehins mentioned this pull request Oct 30, 2023
Merged
@Shimuuar
Copy link
Contributor

That's great! It provides direct correspondence between RandomGen based API and StatefulGen one. Just a few thoughtsfrom me:

  1. modifyM clashes with one from transformers state monad. modifyGen?
  2. This addition mean that one could implement thawGenInplace :: MutableGen f m -> f -> m () which replaces existing mutable generator.

@lehins
Copy link
Contributor Author

lehins commented Oct 30, 2023 •
edited
Loading

  1. modifyM clashes with one from transformers state monad. modifyGen?

modifyGen sounds good to me.

  1. This addition mean that one could implement thawGenInplace :: MutableGen f m -> f -> m () which replaces existing mutable generator.

Yes, that seems like a good feature to me.

@lehins lehins force-pushed the lehins/extend-frozen-gen branch from 2fba77c to 66f0f10 Compare November 12, 2023 12:06
@lehins lehins force-pushed the lehins/extend-frozen-gen branch 4 times, most recently from 14ce716 to c7eb9bd Compare November 24, 2023 15:03
@lehins
Deprecate RandomGenM in favor of a more powerful FrozenGen
a3ec128 
* Addition of `modifyGen` totally removes the need for `RandomGenM`, because
every frozen generator that is a wrapper around `RandomGen` also derives
an instance for `RandomGen`

* Add `splitMutableM` and `splitFrozenM`

* Avoid redundant freeze in `withMutableGen_`
@lehins
Add overwriteGen to FrozenGen
28920e0
@lehins
Move thawGen fromFrozenGen into new ThawedGen type class:
4c1dbd6 
* Also add some laws for `FrozenGen` and `ThawedGen`

This split of `FrozenGen` type class into two is needed because some
mutable generators can't be cloned, becase the mutable state is
stored in the monad they are running in, rather than in the mutable
generator itself.
@lehins
Fix Haddock link for StateT
bc58313
@lehins lehins force-pushed the lehins/extend-frozen-gen branch from c7eb9bd to bc58313 Compare November 24, 2023 15:27
@lehins
Copy link
Contributor Author

lehins commented Nov 24, 2023

This addition mean that one could implement thawGenInplace :: MutableGen f m -> f -> m () which replaces existing mutable generator.

@Shimuuar I've added overwriteGen :: MutableGen f m -> f -> m () to make this feature explicit and allow for more efficient implementation, like in this PR: haskell/mwc-random#89 with copy

@lehins lehins merged commit 9f92421 into master Nov 24, 2023
48 checks passed
lehins added a commit that referenced this pull request Nov 26, 2023
@lehins
Add reference to a recent FrozenGen PR #149 in the changelog
411c7e1 
Also fixup example with `FrozenGen` instance in haddock
@lehins lehins deleted the lehins/extend-frozen-gen branch November 26, 2023 18:26
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this pull request Jan 29, 2025
@depressed-pho
devel/hs-random: update to random-1.3.0
2b00651 
# 1.3.0

* Improve floating point value generation and avoid degenerate cases: [#172](haskell/random#172)
* Add `Uniform` instance for `Maybe` and `Either`: [#167](haskell/random#167)
* Add `Seed`, `SeedGen`, `seedSize`, `seedSizeProxy`, `mkSeed` and `unSeed`:
  [#162](haskell/random#162)
* Add `mkSeedFromByteString`, `unSeedToByteString`, `withSeed`, `withSeedM`, `withSeedFile`,
  `seedGenTypeName`, `nonEmptyToSeed`, `nonEmptyFromSeed`, `withSeedM`, `withSeedMutableGen` and `withSeedMutableGen_`
* Add `SplitGen` and `splitGen`: [#160](haskell/random#160)
* Add `unifromShuffleList` and `unifromShuffleListM`: [#140](haskell/random#140)
* Add `uniformWordR`: [#140](haskell/random#140)
* Add `mkStdGen64`: [#155](haskell/random#155)
* Add `uniformListRM`, `uniformList`, `uniformListR`, `uniforms` and `uniformRs`:
  [#154](haskell/random#154)
* Add compatibility with recently added `ByteArray` to `base`:
  [#153](haskell/random#153)
  * Switch to using `ByteArray` for type class implementation instead of
    `ShortByteString`
  * Add `unsafeUniformFillMutableByteArray` to `RandomGen` and a helper function
    `defaultUnsafeUniformFillMutableByteArray` that makes implementation
    for most instances easier.
  * Add `uniformByteArray`, `uniformByteString` and `uniformFillMutableByteArray`
  * Deprecate `genByteString` in favor of `uniformByteString`
  * Add `uniformByteArrayM` to `StatefulGen`
  * Add `uniformByteStringM` and `uniformShortByteStringM`
  * Deprecate `System.Random.Stateful.uniformShortByteString` in favor of `uniformShortByteStringM` for
    consistent naming and a future plan of removing it from `StatefulGen`
    type class
  * Add a pure `System.Random.uniformShortByteString` generating function.
  * Deprecate `genShortByteString` in favor of `System.Random.uniformShortByteString`
  * Expose a helper function `fillByteArrayST`, that can be used for
    defining implementation for `uniformByteArrayM`
  * Deprecate `genShortByteStringST` and `genShortByteStringIO` in favor of `fillByteArrayST`
* Improve `FrozenGen` interface: [#149](haskell/random#149)
  * Move `thawGen` from `FreezeGen` into the new `ThawGen` type class. Fixes an issue with
    an unlawful instance of `StateGen` for `FreezeGen`.
  * Add `modifyGen` and `overwriteGen` to the `FrozenGen` type class
  * Switch `splitGenM` to use `SplitGen` and `FrozenGen` instead of deprecated `RandomGenM`
  * Add `splitMutableGenM`
  * Switch `randomM` and `randomRM` to use `FrozenGen` instead of `RandomGenM`
  * Deprecate `RandomGenM` in favor of a more powerful `FrozenGen`
* Add `isInRangeOrd` and `isInRangeEnum` that can be used for implementing `isInRange`:
  [#148](haskell/random#148)
* Add `isInRange` to `UniformRange`: [#78](haskell/random#78)
* Add default implementation for `uniformRM` using `Generics`:
  [#92](haskell/random#92)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lehins @Shimuuar