Stats.PopulationStandardDeviation Method

Definition

Namespace: Numerics.NET.Statistics
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0

Overload List

PopulationStandardDeviation(DateTime[])	Returns the population standard deviation of the elements of an array.
PopulationStandardDeviation(Vector<DateTime>)	Returns the population standard deviation of the elements of a numerical variable.
PopulationStandardDeviation<T>(Vector<T>)	Returns the population standard deviation of the elements of a vector.
PopulationStandardDeviation<T>(T[], Boolean)	Returns the population standard deviation of the elements of an array.
PopulationStandardDeviation<T>(IEnumerable<T>, Boolean)	Returns the population standard deviation of the elements of an array.
PopulationStandardDeviation<T>(ReadOnlySpan<T>, Boolean)	Returns the population standard deviation of the elements of a span.

PopulationStandardDeviation(DateTime[])

Returns the population standard deviation of the elements of an array.

public static TimeSpan PopulationStandardDeviation(
	DateTime[] values
)

Visual Basic

Public Shared Function PopulationStandardDeviation ( 
	values As DateTime()
) As TimeSpan

C++/CLI

public:
static TimeSpan PopulationStandardDeviation(
	array<DateTime>^ values
)

static member PopulationStandardDeviation : 
        values : DateTime[] -> TimeSpan

Parameters

values DateTime[]: An DateTime array.

Return Value

TimeSpan
The standard deviation of the elements of values.

Remarks

The standard deviation is a TimeSpan value.

Exceptions

ArgumentNullException

values is null.

PopulationStandardDeviation(Vector<DateTime>)

Returns the population standard deviation of the elements of a numerical variable.

public static TimeSpan PopulationStandardDeviation(
	Vector<DateTime> values
)

Visual Basic

Public Shared Function PopulationStandardDeviation ( 
	values As Vector(Of DateTime)
) As TimeSpan

C++/CLI

public:
static TimeSpan PopulationStandardDeviation(
	Vector<DateTime>^ values
)

static member PopulationStandardDeviation : 
        values : Vector<DateTime> -> TimeSpan

Parameters

values Vector<DateTime>: A Vector<T> of DateTime.

Return Value

TimeSpan
The standard deviation of the elements of values.

Exceptions

ArgumentNullException

values is null.

PopulationStandardDeviation<T>(Vector<T>)

Returns the population standard deviation of the elements of a vector.

public static double PopulationStandardDeviation<T>(
	this Vector<T> values
)

Visual Basic

<ExtensionAttribute>
Public Shared Function PopulationStandardDeviation(Of T) ( 
	values As Vector(Of T)
) As Double

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
static double PopulationStandardDeviation(
	Vector<T>^ values
)

[<ExtensionAttribute>]
static member PopulationStandardDeviation : 
        values : Vector<'T> -> float

Parameters

values Vector<T>: A vector.

Type Parameters

T: The type of the elements of values.

Return Value

Double
The standard deviation of the elements of values.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Vector<T>. 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).

Exceptions

ArgumentNullException

values is null.

PopulationStandardDeviation<T>(T[], Boolean)

Returns the population standard deviation of the elements of an array.

public static double PopulationStandardDeviation<T>(
	this T[] values,
	bool skipMissingValues = false
)

Visual Basic

<ExtensionAttribute>
Public Shared Function PopulationStandardDeviation(Of T) ( 
	values As T(),
	Optional skipMissingValues As Boolean = false
) As Double

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
static double PopulationStandardDeviation(
	array<T>^ values, 
	bool skipMissingValues = false
)

[<ExtensionAttribute>]
static member PopulationStandardDeviation : 
        values : 'T[] * 
        ?skipMissingValues : bool 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> float

Parameters

values T[]: An array of values.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the calculation. The default is false.

Type Parameters

T: The type of the elements of values.

Return Value

Double
The standard deviation of the elements of values.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type T[]. 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).

Exceptions

ArgumentNullException

values is null.

PopulationStandardDeviation<T>(IEnumerable<T>, Boolean)

Returns the population standard deviation of the elements of an array.

public static double PopulationStandardDeviation<T>(
	IEnumerable<T> values,
	bool skipMissingValues = false
)

Visual Basic

Public Shared Function PopulationStandardDeviation(Of T) ( 
	values As IEnumerable(Of T),
	Optional skipMissingValues As Boolean = false
) As Double

C++/CLI

public:
generic<typename T>
static double PopulationStandardDeviation(
	IEnumerable<T>^ values, 
	bool skipMissingValues = false
)

static member PopulationStandardDeviation : 
        values : IEnumerable<'T> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> float

Parameters

values IEnumerable<T>: An object that implements IEnumerable<Double>.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the calculation. The default is false.

Type Parameters

T: The type of the elements of values.

Return Value

Double
The standard deviation of the elements of values.

Remarks

The population standard deviation is the square root of the population variance.

No observed values returns NaN; one finite observed value returns zero.

Exceptions

ArgumentNullException

values is null.

PopulationStandardDeviation<T>(ReadOnlySpan<T>, Boolean)

Returns the population standard deviation of the elements of a span.

public static double PopulationStandardDeviation<T>(
	this ReadOnlySpan<T> values,
	bool skipMissingValues = false
)

Visual Basic

<ExtensionAttribute>
Public Shared Function PopulationStandardDeviation(Of T) ( 
	values As ReadOnlySpan(Of T),
	Optional skipMissingValues As Boolean = false
) As Double

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
static double PopulationStandardDeviation(
	ReadOnlySpan<T> values, 
	bool skipMissingValues = false
)

[<ExtensionAttribute>]
static member PopulationStandardDeviation : 
        values : ReadOnlySpan<'T> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> float

Parameters

values ReadOnlySpan<T>: A span of values.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the calculation. The default is false.

Type Parameters

T: The type of the elements of values.

Return Value

Double
The standard deviation of the elements of values.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ReadOnlySpan<T>. 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).

Stats.PopulationStandardDeviation Method

Definition

Overload List

PopulationStandardDeviation(DateTime[])

Parameters

Return Value

Remarks

Exceptions

PopulationStandardDeviation(Vector<DateTime>)

Parameters

Return Value

Exceptions

PopulationStandardDeviation<T>(Vector<T>)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

PopulationStandardDeviation<T>(T[], Boolean)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

PopulationStandardDeviation<T>(IEnumerable<T>, Boolean)

Parameters

Type Parameters

Return Value

Remarks

Exceptions

PopulationStandardDeviation<T>(ReadOnlySpan<T>, Boolean)

Parameters

Type Parameters

Return Value

Usage Note

See Also

Reference