uo9xpb74
/
mathnet-numerics
forked from tsai/mathnet-numerics
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Statistics: clarifying inline docs on sample variance bias

v2
Christoph Ruegg 13 years ago
parent
b69126a513
commit
1c2b37e320
3 changed files with 24 additions and 24 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 12
      src/Numerics/Statistics/ArrayStatistics.cs
  2. 24
      src/Numerics/Statistics/Statistics.cs
  3. 12
      src/Numerics/Statistics/StreamingStatistics.cs

12
src/Numerics/Statistics/ArrayStatistics.cs
View File

@ -107,7 +107,7 @@ namespace MathNet.Numerics.Statistics
/// <summary> /// <summary>
/// Estimates the unbiased population variance from the provided samples as unsorted array. /// Estimates the unbiased population variance from the provided samples as unsorted array.
/// On a dataset of size N will use an N-1 normalizer. /// On a dataset of size N will use an N-1 normalizer (Bessel's correction).
/// Returns NaN if data has less than two entries or if any entry is NaN. /// Returns NaN if data has less than two entries or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="samples">Sample array, no sorting is assumed.</param> /// <param name="samples">Sample array, no sorting is assumed.</param>
@ -129,7 +129,7 @@ namespace MathNet.Numerics.Statistics
/// <summary> /// <summary>
/// Estimates the unbiased population standard deviation from the provided samples as unsorted array. /// Estimates the unbiased population standard deviation from the provided samples as unsorted array.
/// On a dataset of size N will use an N-1 normalizer. /// On a dataset of size N will use an N-1 normalizer (Bessel's correction).
/// Returns NaN if data has less than two entries or if any entry is NaN. /// Returns NaN if data has less than two entries or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="samples">Sample array, no sorting is assumed.</param> /// <param name="samples">Sample array, no sorting is assumed.</param>
@ -139,8 +139,8 @@ namespace MathNet.Numerics.Statistics
} }
/// <summary> /// <summary>
/// Evaluates the biased population variance from the provided full population as unsorted array. /// Evaluates the population variance from the full population provided as unsorted array.
/// On a dataset of size N will use an N normalizer. /// On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset.
/// Returns NaN if data is empty or if any entry is NaN. /// Returns NaN if data is empty or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="population">Sample array, no sorting is assumed.</param> /// <param name="population">Sample array, no sorting is assumed.</param>
@ -161,8 +161,8 @@ namespace MathNet.Numerics.Statistics
} }
/// <summary> /// <summary>
/// Evaluates the biased population standard deviation from the provided full population as unsorted array. /// Evaluates the population standard deviation from the full population provided as unsorted array.
/// On a dataset of size N will use an N normalizer. /// On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset.
/// Returns NaN if data is empty or if any entry is NaN. /// Returns NaN if data is empty or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="population">Sample array, no sorting is assumed.</param> /// <param name="population">Sample array, no sorting is assumed.</param>

24
src/Numerics/Statistics/Statistics.cs
View File

@ -121,7 +121,7 @@ namespace MathNet.Numerics.Statistics
/// <summary> /// <summary>
/// Estimates the unbiased population variance from the provided samples. /// Estimates the unbiased population variance from the provided samples.
/// On a dataset of size N will use an N-1 normalizer. /// On a dataset of size N will use an N-1 normalizer (Bessel's correction).
/// Returns NaN if data has less than two entries or if any entry is NaN. /// Returns NaN if data has less than two entries or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="samples">A subset of samples, sampled from the full population.</param> /// <param name="samples">A subset of samples, sampled from the full population.</param>
@ -135,7 +135,7 @@ namespace MathNet.Numerics.Statistics
/// <summary> /// <summary>
/// Estimates the unbiased population variance from the provided samples. /// Estimates the unbiased population variance from the provided samples.
/// On a dataset of size N will use an N-1 normalizer. /// On a dataset of size N will use an N-1 normalizer (Bessel's correction).
/// Returns NaN if data has less than two entries or if any entry is NaN. /// Returns NaN if data has less than two entries or if any entry is NaN.
/// Null-entries are ignored. /// Null-entries are ignored.
/// </summary> /// </summary>
@ -147,8 +147,8 @@ namespace MathNet.Numerics.Statistics
} }
/// <summary> /// <summary>
/// Evaluates the biased population variance from the provided full population. /// Evaluates the population variance from the provided full population.
/// On a dataset of size N will use an N normalizer. /// On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset.
/// Returns NaN if data is empty or if any entry is NaN. /// Returns NaN if data is empty or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="population">The full population data.</param> /// <param name="population">The full population data.</param>
@ -161,8 +161,8 @@ namespace MathNet.Numerics.Statistics
} }
/// <summary> /// <summary>
/// Evaluates the biased population variance from the provided full population. /// Evaluates the population variance from the provided full population.
/// On a dataset of size N will use an N normalizer. /// On a dataset of size N will use an N normalize and would thus be biased if applied to a subsetr.
/// Returns NaN if data is empty or if any entry is NaN. /// Returns NaN if data is empty or if any entry is NaN.
/// Null-entries are ignored. /// Null-entries are ignored.
/// </summary> /// </summary>
@ -175,7 +175,7 @@ namespace MathNet.Numerics.Statistics
/// <summary> /// <summary>
/// Estimates the unbiased population standard deviation from the provided samples. /// Estimates the unbiased population standard deviation from the provided samples.
/// On a dataset of size N will use an N-1 normalizer. /// On a dataset of size N will use an N-1 normalizer (Bessel's correction).
/// Returns NaN if data has less than two entries or if any entry is NaN. /// Returns NaN if data has less than two entries or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="samples">A subset of samples, sampled from the full population.</param> /// <param name="samples">A subset of samples, sampled from the full population.</param>
@ -189,7 +189,7 @@ namespace MathNet.Numerics.Statistics
/// <summary> /// <summary>
/// Estimates the unbiased population standard deviation from the provided samples. /// Estimates the unbiased population standard deviation from the provided samples.
/// On a dataset of size N will use an N-1 normalizer. /// On a dataset of size N will use an N-1 normalizer (Bessel's correction).
/// Returns NaN if data has less than two entries or if any entry is NaN. /// Returns NaN if data has less than two entries or if any entry is NaN.
/// Null-entries are ignored. /// Null-entries are ignored.
/// </summary> /// </summary>
@ -201,8 +201,8 @@ namespace MathNet.Numerics.Statistics
} }
/// <summary> /// <summary>
/// Evaluates the biased population standard deviation from the provided full population. /// Evaluates the population standard deviation from the provided full population.
/// On a dataset of size N will use an N normalizer. /// On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset.
/// Returns NaN if data is empty or if any entry is NaN. /// Returns NaN if data is empty or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="population">The full population data.</param> /// <param name="population">The full population data.</param>
@ -215,8 +215,8 @@ namespace MathNet.Numerics.Statistics
} }
/// <summary> /// <summary>
/// Evaluates the biased population standard deviation from the provided full population. /// Evaluates the population standard deviation from the provided full population.
/// On a dataset of size N will use an N normalizer. /// On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset.
/// Returns NaN if data is empty or if any entry is NaN. /// Returns NaN if data is empty or if any entry is NaN.
/// Null-entries are ignored. /// Null-entries are ignored.
/// </summary> /// </summary>

12
src/Numerics/Statistics/StreamingStatistics.cs
View File

@ -108,7 +108,7 @@ namespace MathNet.Numerics.Statistics
/// <summary> /// <summary>
/// Estimates the unbiased population variance from the provided samples as enumerable sequence, in a single pass without memoization. /// Estimates the unbiased population variance from the provided samples as enumerable sequence, in a single pass without memoization.
/// On a dataset of size N will use an N-1 normalizer. /// On a dataset of size N will use an N-1 normalizer (Bessel's correction).
/// Returns NaN if data has less than two entries or if any entry is NaN. /// Returns NaN if data has less than two entries or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="samples">Sample stream, no sorting is assumed.</param> /// <param name="samples">Sample stream, no sorting is assumed.</param>
@ -141,7 +141,7 @@ namespace MathNet.Numerics.Statistics
/// <summary> /// <summary>
/// Estimates the unbiased population standard deviation from the provided samples as enumerable sequence, in a single pass without memoization. /// Estimates the unbiased population standard deviation from the provided samples as enumerable sequence, in a single pass without memoization.
/// On a dataset of size N will use an N-1 normalizer. /// On a dataset of size N will use an N-1 normalizer (Bessel's correction).
/// Returns NaN if data has less than two entries or if any entry is NaN. /// Returns NaN if data has less than two entries or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="samples">Sample stream, no sorting is assumed.</param> /// <param name="samples">Sample stream, no sorting is assumed.</param>
@ -151,8 +151,8 @@ namespace MathNet.Numerics.Statistics
} }
/// <summary> /// <summary>
/// Evaluates the biased population variance from the provided full population as enumerable sequence, in a single pass without memoization. /// Evaluates the population variance from the full population provided as enumerable sequence, in a single pass without memoization.
/// On a dataset of size N will use an N normalizer. /// On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset.
/// Returns NaN if data is empty or if any entry is NaN. /// Returns NaN if data is empty or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="population">Sample stream, no sorting is assumed.</param> /// <param name="population">Sample stream, no sorting is assumed.</param>
@ -184,8 +184,8 @@ namespace MathNet.Numerics.Statistics
} }
/// <summary> /// <summary>
/// Evaluates the biased population standard deviation from the provided full population as enumerable sequence, in a single pass without memoization. /// Evaluates the population standard deviation from the full population provided as enumerable sequence, in a single pass without memoization.
/// On a dataset of size N will use an N normalizer. /// On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset.
/// Returns NaN if data is empty or if any entry is NaN. /// Returns NaN if data is empty or if any entry is NaN.
/// </summary> /// </summary>
/// <param name="population">Sample stream, no sorting is assumed.</param> /// <param name="population">Sample stream, no sorting is assumed.</param>

Write Preview
Loading…
Cancel
Save