FS-1135 implementation - random functions for collections

[Lanayx]

Description

FS-1135 implementation

Checklist

• Test cases added

• Performance benchmarks added in case of performance changes

• Release notes entry updated:

  Please make sure to add an entry with short succinct description of the change as well as link to this pull request to the respective release notes file, if applicable.

  Release notes files:

  • If anything under src/Compiler has been changed, please make sure to make an entry in docs/release-notes/.FSharp.Compiler.Service/<version>.md, where <version> is usually "highest" one, e.g. 42.8.200
  • If language feature was added (i.e. LanguageFeatures.fsi was changed), please add it to docs/releae-notes/.Language/preview.md
  • If a change to FSharp.Core was made, please make sure to edit docs/release-notes/.FSharp.Core/<version>.md where version is "highest" one, e.g. 8.0.200.

  Information about the release notes entries format can be found in the documentation.
  Example:

  • More inlines for Result module. (PR #16106)
  • Correctly handle assembly imports with public key token of 0 length. (Issue #16359, PR #16363)
    *while! (Language suggestion #1038, PR #14238)

  If you believe that release notes are not necessary for this PR, please add NO_RELEASE_NOTES label to the pull request.

[github-actions]

❗ Release notes required

---

✅ Found changes and release notes in following paths:

Change path	Release notes path	Description
src/FSharp.Core	docs/release-notes/.FSharp.Core/8.0.400.md

[Lanayx]

Can somebody please help me pass unit tests? It fails with
Expected and actual surface area don't match. To see the delta, run:

[brianrourkeboll]

Can somebody please help me pass unit tests? It fails with Expected and actual surface area don't match. To see the delta, run:

I think you might want to run something like this

$env:TEST_UPDATE_BSL=1>> dotnet test tests/FSharp.Core.UnitTests/FSharp.Core.UnitTests/-c Release --filter "SurfaceArea"

That should update the baselines (sometimes you may need to run it twice), which you can then commit.

[Lanayx]

Can somebody please help me pass unit tests? It fails with Expected and actual surface area don't match. To see the delta, run:

I think you might want to run something like this

$env:TEST_UPDATE_BSL>> dotnet test tests/FSharp.Core.UnitTests/FSharp.Core.UnitTests -c Release --filter "SurfaceArea"

That should update the baselines (sometimes you may need to run it twice), which you can then commit.

Thanks it worked, just as I figured out it should be $env:TEST_UPDATE_BSL=1

[brianrourkeboll]

just as I figured out it should be $env:TEST_UPDATE_BSL=1

Ah, yeah, whoops

[psfinaki]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[Lanayx]

@abelbraaksma you are welcome to review as well!

[psfinaki]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[psfinaki]

Thanks for this, great effort and great docs.

I haven't looked into the implementation yet, I was rather checking if the API adheres to the RFC - which it does, apart from one exception type in one case.

I will finish my review soon. Overall, I am up for merging this in its current shape. I think this API is good enough. It could probably be made thinner or more discoverable, as per discussions in the related threads. But unless it proves to be a performance trap AND cannot be optimized within the API boundaries in followups - I don't think it's worth starting the design process all over again.

[psfinaki]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[psfinaki]

Good stuff, I am for getting this in (see my comment above).

The implementation LGTM, just give us some time to figure out all this exception naming stuff, also the CI is broken right now.

[psfinaki]

Alright, let's get this in. Thanks for your work @Lanayx. Let's spread the word :)

[T-Gro]

With the introduction of #20229, we can now have if-def-based additions to FSharp.Core that rely on newer runtime APIs. As a follow-up optimization to the FS-1135 random functions here, the internal RNG could reference System.Random.Shared (net6+) under #if NET6_0_OR_GREATER, retiring the [<ThreadStatic>]-based fallback on modern runtimes for a lock-free, allocation-free shared instance.