oliverbooth/X10D
oliverbooth
/
X10D
mirror of https://github.com/oliverbooth/X10D
1
0
Fork 0
Code Issues

🚚 Rename List.OneOf to List.Random 

Item for #21
This commit is contained in:
Oliver Booth 2021-01-18 15:19:59 +00:00
parent 1b80267238
commit 51ba5b0115
1 changed files with 25 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
X10D/src/ListExtensions.cs
View File

@ -1,6 +1,5 @@
using System;
using System.Collections.Generic;
using System.Linq;
namespace X10D
{
@ -10,51 +9,34 @@ namespace X10D
public static class ListExtensions
{
/// <summary>
/// Returns a random element from <paramref name="source" /> using a new <see cref="Random" /> instance.
/// Returns a random element from the current list using a specified <see cref="System.Random" /> instance.
/// </summary>
/// <typeparam name="T">The collection type.</typeparam>
/// <param name="source">The collection to draw from.</param>
/// <returns>Returns a random element of type <see cref="T" /> from <paramref name="source" />.</returns>
public static T OneOf<T>(this IEnumerable<T> source)
/// <typeparam name="T">The element type.</typeparam>
/// <param name="source">The source collection from which to draw.</param>
/// <param name="random">The <see cref="System.Random" /> instance.</param>
/// <returns>A random element of type <see cref="T" /> from <paramref name="source" />.</returns>
/// <exception cref="ArgumentNullException">
/// <paramref name="random" /> is is <see langword="null" />
/// -or-
/// <paramref name="source" /> is <see langword="null" />.
/// </exception>
/// <example>
/// <code lang="csharp">
/// var list = new List&lt;int&gt; { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
/// var number = list.Random();
/// </code>
/// </example>
public static T Random<T>(this IReadOnlyList<T> source, System.Random? random = null)
{
return source.OneOf(new Random());
}
/// <summary>
/// Returns a random element from <paramref name="source" /> using the <see cref="Random" /> instance.
/// </summary>
/// <typeparam name="T">The collection type.</typeparam>
/// <param name="source">The collection to draw from.</param>
/// <param name="random">The <see cref="Random" /> instance.</param>
/// <returns>Returns a random element of type <see cref="T" /> from <paramref name="source" />.</returns>
public static T OneOf<T>(this IEnumerable<T> source, Random random)
{
return source.ToList().OneOf(random);
}
/// <summary>
/// Returns a random element from <paramref name="source" /> using a new <see cref="Random" /> instance.
/// </summary>
/// <typeparam name="T">The collection type.</typeparam>
/// <param name="source">The collection to draw from.</param>
/// <returns>Returns a random element of type <see cref="T" /> from <paramref name="source" />.</returns>
public static T OneOf<T>(this IList<T> source)
{
return source.OneOf(new Random());
}
/// <summary>
/// Returns a random element from <paramref name="source" /> using the <see cref="Random" /> instance.
/// </summary>
/// <typeparam name="T">The collection type.</typeparam>
/// <param name="source">The collection to draw from.</param>
/// <param name="random">The <see cref="Random" /> instance.</param>
/// <returns>Returns a random element of type <see cref="T" /> from <paramref name="source" />.</returns>
public static T OneOf<T>(this IList<T> source, Random random)
{
return random.OneOf(source);
}
if (source is null)
{
throw new ArgumentNullException(nameof(source));
}
random ??= RandomExtensions.Random;
return random.NextFrom(source);
}
/// <summary>
/// Reorganizes the elements in a list by implementing a Fisher-Yates shuffle.
/// </summary>