Stats.Ranks Method

Definition

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

Overload List

Ranks(DateTime[])	Returns the ranks of the observations.
Ranks(Vector<Double>)	Returns the ranks of the observations.
Ranks(DateTime[], RankTiebreaker, TimeSpan)	Returns the ranks of the observations.
Ranks<T>(T[])	Returns the ranks of the observations.
Ranks<T>(T[], RankTiebreaker, T)	Returns the ranks of the observations.
Ranks<T>(ReadOnlySpan<T>, RankTiebreaker, T)	Returns the ranks of the observations.
Ranks<T>(Vector<T>, RankTiebreaker, T)	Returns the ranks of the observations.

Ranks(DateTime[])

Returns the ranks of the observations.

public static double[] Ranks(
	DateTime[] values
)

Visual Basic

Public Shared Function Ranks ( 
	values As DateTime()
) As Double()

C++/CLI

public:
static array<double>^ Ranks(
	array<DateTime>^ values
)

static member Ranks : 
        values : DateTime[] -> float[]

Parameters

values DateTime[]: A Double array.

Return Value

Double[]
A Double array containing the ranks of each observation.

Remarks

The smallest observation has rank 1. If several observations have the same value, then the average of the ranks is used. The rank for missing values is NaN.

Exceptions

ArgumentNullException

values is null.

Ranks<T>(T[])

Returns the ranks of the observations.

public static double[] Ranks<T>(
	T[] values
)

Visual Basic

Public Shared Function Ranks(Of T) ( 
	values As T()
) As Double()

C++/CLI

public:
generic<typename T>
static array<double>^ Ranks(
	array<T>^ values
)

static member Ranks : 
        values : 'T[] -> float[]

Parameters

values T[]: A Double array.

Type Parameters

T

Return Value

Double[]
A Double array containing the ranks of each observation.

Remarks

The smallest observation has rank 1. If several observations have the same value, then the average of the ranks is used. The rank for missing values is NaN.

Exceptions

ArgumentNullException

values is null.

Ranks(Vector<Double>)

Returns the ranks of the observations.

public static Vector<double> Ranks(
	this Vector<double> values
)

Visual Basic

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

C++/CLI

public:
[ExtensionAttribute]
static Vector<double>^ Ranks(
	Vector<double>^ values
)

[<ExtensionAttribute>]
static member Ranks : 
        values : Vector<float> -> Vector<float>

Parameters

values Vector<Double>: A Double array.

Return Value

Vector<Double>
A Double array containing the ranks of each observation.

Usage Note

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

The smallest observation has rank 1. If several observations have the same value, then the average of the ranks is used. The rank for missing values is NaN.

Exceptions

ArgumentNullException

values is null.

Ranks(DateTime[], RankTiebreaker, TimeSpan)

Returns the ranks of the observations.

public static double[] Ranks(
	DateTime[] values,
	RankTiebreaker tiebreaker,
	TimeSpan tolerance
)

Visual Basic

Public Shared Function Ranks ( 
	values As DateTime(),
	tiebreaker As RankTiebreaker,
	tolerance As TimeSpan
) As Double()

C++/CLI

public:
static array<double>^ Ranks(
	array<DateTime>^ values, 
	RankTiebreaker tiebreaker, 
	TimeSpan tolerance
)

static member Ranks : 
        values : DateTime[] * 
        tiebreaker : RankTiebreaker * 
        tolerance : TimeSpan -> float[]

Parameters

values DateTime[]: A Double array.
tiebreaker RankTiebreaker: A RankTiebreaker value that specifies how to assign the ranks of tied observations.
tolerance TimeSpan: A TimeSpan value that specifies the largest difference between values for which ranks should be considered tied.

Return Value

Double[]
A Double array containing the ranks of each observation.

Remarks

The smallest observation has rank 1. Observations that are within the value tolerance of each other are considered equal. If several values are equal, then the rank is assigned using the method specified by tiebreaker.

Exceptions

ArgumentNullException

values is null.

Ranks<T>(T[], RankTiebreaker, T)

Returns the ranks of the observations.

public static double[] Ranks<T>(
	this T[] values,
	RankTiebreaker tiebreaker,
	T tolerance
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Ranks(Of T) ( 
	values As T(),
	tiebreaker As RankTiebreaker,
	tolerance As T
) As Double()

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
static array<double>^ Ranks(
	array<T>^ values, 
	RankTiebreaker tiebreaker, 
	T tolerance
)

[<ExtensionAttribute>]
static member Ranks : 
        values : 'T[] * 
        tiebreaker : RankTiebreaker * 
        tolerance : 'T -> float[]

Parameters

values T[]: An array of values.
tiebreaker RankTiebreaker: A RankTiebreaker value that specifies how to assign the ranks of tied observations.
tolerance T: The absolute tolerance used to decide whether two values are considered equal.

Type Parameters

T

Return Value

Double[]
A Double array containing the ranks of each observation.

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).

Remarks

Exceptions

ArgumentNullException

values is null.

Ranks<T>(ReadOnlySpan<T>, RankTiebreaker, T)

Returns the ranks of the observations.

public static double[] Ranks<T>(
	this ReadOnlySpan<T> values,
	RankTiebreaker tiebreaker,
	T tolerance
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Ranks(Of T) ( 
	values As ReadOnlySpan(Of T),
	tiebreaker As RankTiebreaker,
	tolerance As T
) As Double()

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
static array<double>^ Ranks(
	ReadOnlySpan<T> values, 
	RankTiebreaker tiebreaker, 
	T tolerance
)

[<ExtensionAttribute>]
static member Ranks : 
        values : ReadOnlySpan<'T> * 
        tiebreaker : RankTiebreaker * 
        tolerance : 'T -> float[]

Parameters

values ReadOnlySpan<T>: An array of values.
tiebreaker RankTiebreaker: A RankTiebreaker value that specifies how to assign the ranks of tied observations.
tolerance T: The absolute tolerance used to decide whether two values are considered equal.

Type Parameters

T

Return Value

Double[]
A Double array containing the ranks of each observation.

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).

Remarks

Exceptions

ArgumentNullException

values is null.

Ranks<T>(Vector<T>, RankTiebreaker, T)

Returns the ranks of the observations.

public static Vector<double> Ranks<T>(
	this Vector<T> values,
	RankTiebreaker tiebreaker,
	T tolerance
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Ranks(Of T) ( 
	values As Vector(Of T),
	tiebreaker As RankTiebreaker,
	tolerance As T
) As Vector(Of Double)

C++/CLI

public:
[ExtensionAttribute]
generic<typename T>
static Vector<double>^ Ranks(
	Vector<T>^ values, 
	RankTiebreaker tiebreaker, 
	T tolerance
)

[<ExtensionAttribute>]
static member Ranks : 
        values : Vector<'T> * 
        tiebreaker : RankTiebreaker * 
        tolerance : 'T -> Vector<float>

Parameters

values Vector<T>: A vector of values.
tiebreaker RankTiebreaker: A RankTiebreaker value that specifies how to assign the ranks of tied observations.
tolerance T: The absolute tolerance used to decide whether two values are considered equal.

Type Parameters

T

Return Value

Vector<Double>
A Double array containing the ranks of each observation.

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).

Remarks

Exceptions

ArgumentNullException

values is null.

Stats.Ranks Method

Definition

Overload List

Ranks(DateTime[])

Parameters

Return Value

Remarks

Exceptions

Ranks<T>(T[])

Parameters

Type Parameters

Return Value

Remarks

Exceptions

Ranks(Vector<Double>)

Parameters

Return Value

Usage Note

Remarks

Exceptions

Ranks(DateTime[], RankTiebreaker, TimeSpan)

Parameters

Return Value

Remarks

Exceptions

Ranks<T>(T[], RankTiebreaker, T)

Parameters

Type Parameters

Return Value

Usage Note

Remarks

Exceptions

Ranks<T>(ReadOnlySpan<T>, RankTiebreaker, T)

Parameters

Type Parameters

Return Value

Usage Note

Remarks

Exceptions

Ranks<T>(Vector<T>, RankTiebreaker, T)

Parameters

Type Parameters

Return Value

Usage Note

Remarks

Exceptions

See Also

Reference