diff --git a/src/Numerics/Statistics/ArrayStatistics.cs b/src/Numerics/Statistics/ArrayStatistics.cs index 980dd472..92deba98 100644 --- a/src/Numerics/Statistics/ArrayStatistics.cs +++ b/src/Numerics/Statistics/ArrayStatistics.cs @@ -107,7 +107,7 @@ namespace MathNet.Numerics.Statistics /// /// 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. /// /// Sample array, no sorting is assumed. @@ -129,7 +129,7 @@ namespace MathNet.Numerics.Statistics /// /// 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. /// /// Sample array, no sorting is assumed. @@ -139,8 +139,8 @@ namespace MathNet.Numerics.Statistics } /// - /// Evaluates the biased population variance from the provided full population as unsorted array. - /// On a dataset of size N will use an N normalizer. + /// Evaluates the population variance from the full population provided as unsorted array. + /// 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. /// /// Sample array, no sorting is assumed. @@ -161,8 +161,8 @@ namespace MathNet.Numerics.Statistics } /// - /// Evaluates the biased population standard deviation from the provided full population as unsorted array. - /// On a dataset of size N will use an N normalizer. + /// Evaluates the population standard deviation from the full population provided as unsorted array. + /// 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. /// /// Sample array, no sorting is assumed. diff --git a/src/Numerics/Statistics/Statistics.cs b/src/Numerics/Statistics/Statistics.cs index 6bff4d0d..f9c80bc3 100644 --- a/src/Numerics/Statistics/Statistics.cs +++ b/src/Numerics/Statistics/Statistics.cs @@ -121,7 +121,7 @@ namespace MathNet.Numerics.Statistics /// /// 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. /// /// A subset of samples, sampled from the full population. @@ -135,7 +135,7 @@ namespace MathNet.Numerics.Statistics /// /// 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. /// Null-entries are ignored. /// @@ -147,8 +147,8 @@ namespace MathNet.Numerics.Statistics } /// - /// Evaluates the biased population variance from the provided full population. - /// On a dataset of size N will use an N normalizer. + /// Evaluates the population variance from the provided full population. + /// 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. /// /// The full population data. @@ -161,8 +161,8 @@ namespace MathNet.Numerics.Statistics } /// - /// Evaluates the biased population variance from the provided full population. - /// On a dataset of size N will use an N normalizer. + /// Evaluates the population variance from the provided full population. + /// 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. /// Null-entries are ignored. /// @@ -175,7 +175,7 @@ namespace MathNet.Numerics.Statistics /// /// 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. /// /// A subset of samples, sampled from the full population. @@ -189,7 +189,7 @@ namespace MathNet.Numerics.Statistics /// /// 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. /// Null-entries are ignored. /// @@ -201,8 +201,8 @@ namespace MathNet.Numerics.Statistics } /// - /// Evaluates the biased population standard deviation from the provided full population. - /// On a dataset of size N will use an N normalizer. + /// Evaluates the population standard deviation from the provided full population. + /// 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. /// /// The full population data. @@ -215,8 +215,8 @@ namespace MathNet.Numerics.Statistics } /// - /// Evaluates the biased population standard deviation from the provided full population. - /// On a dataset of size N will use an N normalizer. + /// Evaluates the population standard deviation from the provided full population. + /// 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. /// Null-entries are ignored. /// diff --git a/src/Numerics/Statistics/StreamingStatistics.cs b/src/Numerics/Statistics/StreamingStatistics.cs index e18bec7b..2170cb73 100644 --- a/src/Numerics/Statistics/StreamingStatistics.cs +++ b/src/Numerics/Statistics/StreamingStatistics.cs @@ -108,7 +108,7 @@ namespace MathNet.Numerics.Statistics /// /// 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. /// /// Sample stream, no sorting is assumed. @@ -141,7 +141,7 @@ namespace MathNet.Numerics.Statistics /// /// 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. /// /// Sample stream, no sorting is assumed. @@ -151,8 +151,8 @@ namespace MathNet.Numerics.Statistics } /// - /// Evaluates the biased population variance from the provided full population as enumerable sequence, in a single pass without memoization. - /// On a dataset of size N will use an N normalizer. + /// 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 and would thus be biased if applied to a subset. /// Returns NaN if data is empty or if any entry is NaN. /// /// Sample stream, no sorting is assumed. @@ -184,8 +184,8 @@ namespace MathNet.Numerics.Statistics } /// - /// Evaluates the biased population standard deviation from the provided full population as enumerable sequence, in a single pass without memoization. - /// On a dataset of size N will use an N normalizer. + /// 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 and would thus be biased if applied to a subset. /// Returns NaN if data is empty or if any entry is NaN. /// /// Sample stream, no sorting is assumed.