Stats.StandardDeviation Method

Definition

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

Overload List

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

StandardDeviation(DateTime[])

Returns the standard deviation of the elements of an array.

public static TimeSpan StandardDeviation(
	DateTime[] values
)

Visual Basic

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

C++/CLI

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

static member StandardDeviation : 
        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.

StandardDeviation(Vector<DateTime>)

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

public static TimeSpan StandardDeviation(
	this Vector<DateTime> values
)

Visual Basic

<ExtensionAttribute>
Public Shared Function StandardDeviation ( 
	values As Vector(Of DateTime)
) As TimeSpan

C++/CLI

public:
[ExtensionAttribute]
static TimeSpan StandardDeviation(
	Vector<DateTime>^ values
)

[<ExtensionAttribute>]
static member StandardDeviation : 
        values : Vector<DateTime> -> TimeSpan

Parameters

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

Return Value

TimeSpan
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<DateTime>. 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.

StandardDeviation<T>(Vector<T>)

Returns the standard deviation of the elements of a vector.

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

Visual Basic

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

C++/CLI

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

[<ExtensionAttribute>]
static member StandardDeviation : 
        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.

StandardDeviation<T>(T[], Boolean)

Returns the standard deviation of the elements of an array.

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

Visual Basic

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

C++/CLI

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

[<ExtensionAttribute>]
static member StandardDeviation : 
        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.

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

Returns the standard deviation of the elements of a sequence.

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

Visual Basic

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

C++/CLI

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

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

Parameters

values IEnumerable<T>: A sequence 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 IEnumerable<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.

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

Returns the standard deviation of the elements of a span.

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

Visual Basic

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

C++/CLI

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

[<ExtensionAttribute>]
static member StandardDeviation : 
        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.StandardDeviation Method

Definition

Overload List

StandardDeviation(DateTime[])

Parameters

Return Value

Remarks

Exceptions

StandardDeviation(Vector<DateTime>)

Parameters

Return Value

Usage Note

Exceptions

StandardDeviation<T>(Vector<T>)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

StandardDeviation<T>(T[], Boolean)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

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

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

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

Parameters

Type Parameters

Return Value

Usage Note

See Also

Reference