UnivariatePopulationMean Method

Estimates the mean of the underlying population.

Definition

Namespace: Meta.Numerics.Statistics
Assembly: Meta.Numerics (in Meta.Numerics.dll) Version: 4.2.0+6d77d64445f7d5d91b12e331399c4362ecb25333

C#

public static UncertainValue PopulationMean(
	this IReadOnlyCollection<double> sample
)

VB

<ExtensionAttribute>
Public Shared Function PopulationMean ( 
	sample As IReadOnlyCollection(Of Double)
) As UncertainValue

C++

public:
[ExtensionAttribute]
static UncertainValue PopulationMean(
	IReadOnlyCollection<double>^ sample
)

F#

[<ExtensionAttribute>]
static member PopulationMean : 
        sample : IReadOnlyCollection<float> -> UncertainValue

Parameters

sample IReadOnlyCollectionDouble: The sample.

Return Value

UncertainValue
An estimate, with uncertainty, of the mean of the distribution from which the sample was drawn.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadOnlyCollectionDouble. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

In contrast to the Mean(IReadOnlyCollectionDouble) method, this method estimates the mean of the underlying population from which the sample was drawn, and provides a error estimate for that value.

Exceptions

ArgumentNullException	sample is .
InsufficientDataException	sample contains fewer than 2 values.