Stats.Quantiles Method

Definition

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

Overload List

Quantiles(Double[], Double[])	Gets the specified quantiles.
Quantiles(Vector<Double>, Double[])	Gets the specified quantiles.
Quantiles(Vector<Double>, ReadOnlySpan<Double>)	Gets the specified quantiles.
Quantiles<T>(Vector<T>, Double[])	Gets the specified quantiles.

Quantiles(Double[], Double[])

Gets the specified quantiles.

public static double[] Quantiles(
	double[] values,
	double[] probabilities
)

Visual Basic

Public Shared Function Quantiles ( 
	values As Double(),
	probabilities As Double()
) As Double()

C++/CLI

public:
static array<double>^ Quantiles(
	array<double>^ values, 
	array<double>^ probabilities
)

static member Quantiles : 
        values : float[] * 
        probabilities : float[] -> float[]

Parameters

values Double[]: A Double array.
probabilities Double[]: An array of values between 0 and 1, inclusive.

Return Value

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

Remarks

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

Exceptions

ArgumentNullException

values is null.

-or-

probabilities is null.

ArgumentException

One or more of the elements of probabilities is less than zero or greater than 1.

Quantiles(Vector<Double>, Double[])

Gets the specified quantiles.

public static double[] Quantiles(
	this Vector<double> values,
	double[] probabilities
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Quantiles ( 
	values As Vector(Of Double),
	probabilities As Double()
) As Double()

C++/CLI

public:
[ExtensionAttribute]
static array<double>^ Quantiles(
	Vector<double>^ values, 
	array<double>^ probabilities
)

[<ExtensionAttribute>]
static member Quantiles : 
        values : Vector<float> * 
        probabilities : float[] -> float[]

Parameters

values Vector<Double>: A vector.
probabilities Double[]: An array of values between 0 and 1, inclusive.

Return Value

Double[]
A Double array containing the quantiles for the percentage specified by the corresponding elements of probabilities.

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 quantile falls between two observations, it is interpolated between the adjacent observations.

Exceptions

ArgumentNullException

values is null.

-or-

probabilities is null.

ArgumentException

One or more of the elements of probabilities is less than zero or greater than 1.

Quantiles(Vector<Double>, ReadOnlySpan<Double>)

Gets the specified quantiles.

public static double[] Quantiles(
	this Vector<double> values,
	ReadOnlySpan<double> probabilities
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Quantiles ( 
	values As Vector(Of Double),
	probabilities As ReadOnlySpan(Of Double)
) As Double()

C++/CLI

public:
[ExtensionAttribute]
static array<double>^ Quantiles(
	Vector<double>^ values, 
	ReadOnlySpan<double> probabilities
)

[<ExtensionAttribute>]
static member Quantiles : 
        values : Vector<float> * 
        probabilities : ReadOnlySpan<float> -> float[]

Parameters

values Vector<Double>: A vector.
probabilities ReadOnlySpan<Double>: An array of values between 0 and 1, inclusive.

Return Value

Double[]
A Double array containing the quantiles for the percentage specified by the corresponding elements of probabilities.

Usage Note

Remarks

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

Exceptions

ArgumentNullException

values is null.

-or-

probabilities is null.

ArgumentException

One or more of the elements of probabilities is less than zero or greater than 1.

Quantiles<T>(Vector<T>, Double[])

Gets the specified quantiles.

public static T[] Quantiles<T>(
	Vector<T> values,
	double[] probabilities
)

Visual Basic

Public Shared Function Quantiles(Of T) ( 
	values As Vector(Of T),
	probabilities As Double()
) As T()

C++/CLI

public:
generic<typename T>
static array<T>^ Quantiles(
	Vector<T>^ values, 
	array<double>^ probabilities
)

static member Quantiles : 
        values : Vector<'T> * 
        probabilities : float[] -> 'T[]

Parameters

values Vector<T>: A Vector<T>.
probabilities Double[]: An array of values between 0 and 1, inclusive.

Type Parameters

T

Return Value

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

Remarks

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

Exceptions

ArgumentNullException

values is null.

-or-

probabilities is null.

ArgumentException

One or more of the elements of probabilities is less than zero or greater than 1.

Stats.Quantiles Method

Definition

Overload List

Quantiles(Double[], Double[])

Parameters

Return Value

Remarks

Exceptions

Quantiles(Vector<Double>, Double[])

Parameters

Return Value

Usage Note

Remarks

Exceptions

Quantiles(Vector<Double>, ReadOnlySpan<Double>)

Parameters

Return Value

Usage Note

Remarks

Exceptions

Quantiles<T>(Vector<T>, Double[])

Parameters

Type Parameters

Return Value

Remarks

Exceptions

See Also

Reference