Stats.Percentiles Method

Definition

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

Overload List

Percentiles(Double[], Int32[])	Gets the specified percentiles.
Percentiles(Vector<Double>, Int32[])	Gets the specified percentiles.
Percentiles(Vector<Double>, ReadOnlySpan<Int32>)	Gets the specified percentiles.
Percentiles<T>(Vector<T>, Int32[])	Gets the specified percentiles.

Percentiles(Double[], Int32[])

Gets the specified percentiles.

public static double[] Percentiles(
	double[] values,
	int[] percents
)

Visual Basic

Public Shared Function Percentiles ( 
	values As Double(),
	percents As Integer()
) As Double()

C++/CLI

public:
static array<double>^ Percentiles(
	array<double>^ values, 
	array<int>^ percents
)

static member Percentiles : 
        values : float[] * 
        percents : int[] -> float[]

Parameters

values Double[]: A Double array.
percents Int32[]: An array of integers between 0 and 100, inclusive.

Return Value

Double[]
A Double array containing the percentiles for to the percentage specified by the corresponding elements of percents.

Remarks

If a percentile falls between two observations, it is interpolated between the adjacent observations.

Exceptions

ArgumentNullException

values is null.

-or-

percents is null.

ArgumentException

One or more of the elements of percents is less than zero or greater than 100.

Percentiles(Vector<Double>, Int32[])

Gets the specified percentiles.

public static double[] Percentiles(
	this Vector<double> values,
	params int[] percents
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Percentiles ( 
	values As Vector(Of Double),
	ParamArray percents As Integer()
) As Double()

C++/CLI

public:
[ExtensionAttribute]
static array<double>^ Percentiles(
	Vector<double>^ values, 
	... array<int>^ percents
)

[<ExtensionAttribute>]
static member Percentiles : 
        values : Vector<float> * 
        percents : int[] -> float[]

Parameters

values Vector<Double>: A vector.
percents Int32[]: An array of integers between 0 and 100, inclusive.

Return Value

Double[]
A Double array containing the percentiles for to the percentage specified by the corresponding elements of percents.

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

If a percentile falls between two observations, it is interpolated between the adjacent observations.

Exceptions

ArgumentNullException

values is null.

-or-

percents is null.

ArgumentException

One or more of the elements of percents is less than zero or greater than 100.

Percentiles(Vector<Double>, ReadOnlySpan<Int32>)

Gets the specified percentiles.

public static double[] Percentiles(
	this Vector<double> values,
	ReadOnlySpan<int> percents
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Percentiles ( 
	values As Vector(Of Double),
	percents As ReadOnlySpan(Of Integer)
) As Double()

C++/CLI

public:
[ExtensionAttribute]
static array<double>^ Percentiles(
	Vector<double>^ values, 
	ReadOnlySpan<int> percents
)

[<ExtensionAttribute>]
static member Percentiles : 
        values : Vector<float> * 
        percents : ReadOnlySpan<int> -> float[]

Parameters

values Vector<Double>: A vector.
percents ReadOnlySpan<Int32>: An array of integers between 0 and 100, inclusive.

Return Value

Double[]
A Double array containing the percentiles for to the percentage specified by the corresponding elements of percents.

Usage Note

Remarks

If a percentile falls between two observations, it is interpolated between the adjacent observations.

Exceptions

ArgumentNullException

values is null.

-or-

percents is null.

ArgumentException

One or more of the elements of percents is less than zero or greater than 100.

Percentiles<T>(Vector<T>, Int32[])

Gets the specified percentiles.

public static T[] Percentiles<T>(
	Vector<T> values,
	int[] percents
)

Visual Basic

Public Shared Function Percentiles(Of T) ( 
	values As Vector(Of T),
	percents As Integer()
) As T()

C++/CLI

public:
generic<typename T>
static array<T>^ Percentiles(
	Vector<T>^ values, 
	array<int>^ percents
)

static member Percentiles : 
        values : Vector<'T> * 
        percents : int[] -> 'T[]

Parameters

values Vector<T>: A Vector<T>.
percents Int32[]: An array of integers between 0 and 100, inclusive.

Type Parameters

T

Return Value

T[]
A Double array containing the percentiles for to the percentage specified by the corresponding elements of percents.

Remarks

If a percentile falls between two observations, it is interpolated between the adjacent observations.

Exceptions

ArgumentNullException

values is null.

-or-

percents is null.

ArgumentException

One or more of the elements of percents is less than zero or greater than 100.

Stats.Percentiles Method

Definition

Overload List

Percentiles(Double[], Int32[])

Parameters

Return Value

Remarks

Exceptions

Percentiles(Vector<Double>, Int32[])

Parameters

Return Value

Usage Note

Remarks

Exceptions

Percentiles(Vector<Double>, ReadOnlySpan<Int32>)

Parameters

Return Value

Usage Note

Remarks

Exceptions

Percentiles<T>(Vector<T>, Int32[])

Parameters

Type Parameters

Return Value

Remarks

Exceptions

See Also

Reference