Browse Source

Inline doc, cls compliance

optimization-3
Christoph Ruegg 13 years ago
parent
commit
21842ca4c6
  1. 3
      src/Numerics/Generate.cs
  2. 2
      src/Numerics/Random/Xorshift.cs

3
src/Numerics/Generate.cs

@ -272,7 +272,7 @@ namespace MathNet.Numerics
/// Create a periodic sample vector.
/// </summary>
/// <param name="length">The number of samples to generate.</param>
/// <param name="map"></param>
/// <param name="map">The function to apply to each of the values and evaluate the resulting sample.</param>
/// <param name="samplingRate">Samples per time unit (Hz). Must be larger than twice the frequency to satisfy the Nyquist criterion.</param>
/// <param name="frequency">Frequency in periods per time unit (Hz).</param>
/// <param name="amplitude">The lenght of the period when sampled at one sample per time unit. This is the interval of the periodic domain, a typical value is 1.0, or 2*Pi for angular functions.</param>
@ -330,6 +330,7 @@ namespace MathNet.Numerics
/// <summary>
/// Create an infinite periodic sample sequence.
/// </summary>
/// <param name="map">The function to apply to each of the values and evaluate the resulting sample.</param>
/// <param name="samplingRate">Samples per time unit (Hz). Must be larger than twice the frequency to satisfy the Nyquist criterion.</param>
/// <param name="frequency">Frequency in periods per time unit (Hz).</param>
/// <param name="amplitude">The lenght of the period when sampled at one sample per time unit. This is the interval of the periodic domain, a typical value is 1.0, or 2*Pi for angular functions.</param>

2
src/Numerics/Random/Xorshift.cs

@ -266,6 +266,7 @@ namespace MathNet.Numerics.Random
/// <summary>
/// Returns an array of random numbers greater than or equal to 0.0 and less than 1.0.
/// </summary>
[CLSCompliant(false)]
public static double[] Samples(int length, int seed, ulong a = ASeed, ulong c = CSeed, ulong x1 = YSeed, ulong x2 = ZSeed)
{
if (a <= c)
@ -295,6 +296,7 @@ namespace MathNet.Numerics.Random
/// <summary>
/// Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0.
/// </summary>
[CLSCompliant(false)]
public static IEnumerable<double> SampleSequence(int seed, ulong a = ASeed, ulong c = CSeed, ulong x1 = YSeed, ulong x2 = ZSeed)
{
if (a <= c)

Loading…
Cancel
Save