MedallionRandom.xml 5.96 KB
Newer Older
M1888's avatar
M1888 committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>MedallionRandom</name>
    </assembly>
    <members>
        <member name="T:Medallion.Rand">
            <summary>
            Contains helpers and extensions for working with random number generators
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextBoolean(System.Random)">
            <summary>
            Returns a random boolean value
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextInt32(System.Random)">
            <summary>
            Returns a random 32-bit integer
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextInt64(System.Random)">
            <summary>
            Returns a random 64-bit integer
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextSingle(System.Random)">
            <summary>
            Returns a random <see cref="T:System.Single"/> value in [0, 1)
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextDoubles(System.Random)">
            <summary>
            Returns the sequence of values that would be generated by repeated
            calls to <see cref="M:System.Random.NextDouble"/>
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextBoolean(System.Random,System.Double)">
            <summary>
            Returns true with probability <paramref name="probability"/>
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextBytes(System.Random)">
            <summary>
            Returns the sequence of bytes that would be returned by repeated calls
            to <see cref="M:System.Random.NextBytes(System.Byte[])"/>
            </summary>
        </member>
        <member name="M:Medallion.Rand.Shuffled``1(System.Collections.Generic.IEnumerable{``0},System.Random)">
            <summary>
            Returns <paramref name="source"/> randomly shuffled using 
            <paramref name="random"/> or else <see cref="P:Medallion.Rand.Current"/>.
            
            This method performs a lazy "streaming" shuffle: when the first
            element of the returned <see cref="T:System.Collections.Generic.IEnumerable`1"/> is requested, the
            entire <paramref name="source"/> sequence is enumerated. The <paramref name="random"/>
            is then used lazily to shuffle the next element into place as the result
            sequence is enumerated
            </summary>
        </member>
        <member name="M:Medallion.Rand.Shuffle``1(System.Collections.Generic.IList{``0},System.Random)">
            <summary>
            Shuffles the given <paramref name="list"/> using <paramref name="random"/> 
            if provided or else <see cref="P:Medallion.Rand.Current"/>
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextGaussian(System.Random)">
            <summary>
            Returns a normally-distributed double value with mean 0 and standard deviation 1
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextDouble(System.Random,System.Double)">
            <summary>
            Returns a random double value uniformly in [0, <paramref name="max"/>). The underlying randomness is
            provided by <see cref="M:System.Random.NextDouble"/>, which may be unsuitable for very large ranges
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextDouble(System.Random,System.Double,System.Double)">
            <summary>
            Returns a random double value uniformly in [<paramref name="min"/>, <paramref name="max"/>). The 
            underlying randomness is provided by <see cref="M:System.Random.NextDouble"/>, which may be unsuitable for 
            very large ranges
            </summary>
        </member>
        <member name="P:Medallion.Rand.Current">
            <summary>
            Returns a thread-safe <see cref="T:System.Random"/> instance which can be used 
            for static random calls
            </summary>
        </member>
        <member name="M:Medallion.Rand.NextDouble">
            <summary>
            Returns a double value in [0, 1)
            </summary>
        </member>
        <member name="M:Medallion.Rand.Next(System.Int32,System.Int32)">
            <summary>
            Returns an int value in [<paramref name="minValue"/>, <paramref name="maxValue"/>)
            </summary>
        </member>
        <member name="M:Medallion.Rand.Create">
            <summary>
            Comparable to <code>new Random()</code>, but seeds the <see cref="T:System.Random"/> with
            a time-dependent value that will still vary greatly across calls to <see cref="M:Medallion.Rand.Create"/>.
            This avoids the problem of many <see cref="T:System.Random"/>s created close together being seeded
            with the same value
            </summary>
        </member>
        <member name="M:Medallion.Rand.CreateJavaRandom">
            <summary>
            Creates a <see cref="T:System.Random"/> that uses the same algorithm as the JRE. The <see cref="T:System.Random"/>
            is seeded with a time-dependent value which will vary greatly even across close-together calls to
            <see cref="M:Medallion.Rand.CreateJavaRandom"/>
            </summary>
        </member>
        <member name="M:Medallion.Rand.CreateJavaRandom(System.Int64)">
            <summary>
            Creates a <see cref="T:System.Random"/> which replicates the same random sequence as is produced by
            the standard random number generator in the JRE using the same <paramref name="seed"/>
            </summary>
        </member>
        <member name="M:Medallion.Rand.AsRandom(System.Security.Cryptography.RandomNumberGenerator)">
            <summary>
            Returns a <see cref="T:System.Random"/> instance which uses the given <paramref name="randomNumberGenerator"/>
            as a source of randomness
            </summary>
        </member>
    </members>
</doc>