Stats.Percentiles Method

Definition

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

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.
C#
public static double[] Percentiles(
	double[] values,
	int[] percents
)

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.
C#
public static double[] Percentiles(
	this Vector<double> values,
	params int[] percents
)

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.
C#
public static double[] Percentiles(
	this Vector<double> values,
	ReadOnlySpan<int> percents
)

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

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<T>(Vector<T>, Int32[])

Gets the specified percentiles.
C#
public static T[] Percentiles<T>(
	Vector<T> values,
	int[] percents
)

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.

See Also