CLSS.ExtensionMethods.IList.ExclusiveSample 1.1.0

dotnet add package CLSS.ExtensionMethods.IList.ExclusiveSample --version 1.1.0
NuGet\Install-Package CLSS.ExtensionMethods.IList.ExclusiveSample -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CLSS.ExtensionMethods.IList.ExclusiveSample" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CLSS.ExtensionMethods.IList.ExclusiveSample --version 1.1.0
#r "nuget: CLSS.ExtensionMethods.IList.ExclusiveSample, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install CLSS.ExtensionMethods.IList.ExclusiveSample as a Cake Addin
#addin nuget:?package=CLSS.ExtensionMethods.IList.ExclusiveSample&version=1.1.0

// Install CLSS.ExtensionMethods.IList.ExclusiveSample as a Cake Tool
#tool nuget:?package=CLSS.ExtensionMethods.IList.ExclusiveSample&version=1.1.0

CLSS.ExtensionMethods.IList.ExclusiveSample

Problem

Randomly selecting an element out of a list is a simple operation. So is selecting multiple repeatable elements out of a list. But what if you want to randomly select k number of non-repeating elements out of a list? This operation is called "exclusive sampling" here to hint at its non-repeating nature.

Naively, you can write elements.OrderBy(e => rng.Next()).Take(k), but this has a time complexity of O(n log n). Alternatively, you can also replace the .OrderBy(e => rng.Next()) with a Fisher-Yates shuffle to achieve a time complexity of O(n). This algorithm still has some problems:

  • It will mutate the source list, necessitating an allocation of its clone - thus a space complexity of O(n) - if you want to leave the source list untampered.
  • Performing a Fisher-Yates shuffle will also iterate through the entire list in all cases, hence the complexity is O(n) even in the best-case scenario.
  • The sampled results will not be in-order, which may not be desirable for your use-cases.

Solution

In The Art of Computer Programming Volume 2, Donald Knuth introduced the following algorithm:

Algorithm S (Selection sampling technique). To select n records at random from a set of N, where 0 < nN.

S1. [Initialize.] Set t ← 0, m ← 0. (During this algorithm, m represents the number of records selected so far, and t is the total number of input records that we have dealt with.)

S2. [Generate U.] Generate a random number U, uniformly distributed between zero and one.

S3. [Test.] If (N - t)Un - m, go to step S5.

S4. [Select.] Select the next record for the sample, and increase m and t by 1. If m < t, go to step S2; otherwise the sample is complete and the algorithm terminates.

S5. [Skip.] Skip the next record (do not include it in the sample), increase t by 1, and go back to step S2.

ExclusiveSample is an implementation of the above algorithm for all IList<T> types. It has a time complexity of O(n) only in the worst-case and a space complexity of O(1). It does not mutate the source list. It returns sampled results in-order.

This method optionally takes in an existing System.Random instance which is seeded with a custom value you would prefer for the sample. Otherwise, it rolls for a random number using the CLSS's shared DefaultRandom instance. If you are on .NET 6, you can pass in System.Random.Shared.

Note: ExclusiveSample works on all types implementing the IList<T> interface, including raw C# array.

This package is a part of the C# Language Syntactic Sugar suite.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.0 is compatible.  netstandard1.1 was computed.  netstandard1.2 was computed.  netstandard1.3 was computed.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Windows Phone wp8 was computed.  wp81 was computed.  wpa81 was computed. 
Windows Store netcore was computed.  netcore45 was computed.  netcore451 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 1,243 8/13/2022
1.0.0 1,176 8/4/2022

- Automatically use the latest CLSS dependency version.