Tensor.Quantile Method

Definition

Namespace: Numerics.NET.Tensors
Assembly: Numerics.NET.Tensors (in Numerics.NET.Tensors.dll) Version: 9.0.0

Overload List

Quantile<T>(Tensor<T>, Double, Tensor<Boolean>, Boolean) Computes the quantile of the elements of a tensor.
Quantile<T>(Tensor<T>, Double, Axes, Tensor<T>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder) Computes the quantiles of the elements of a tensor along the specified axis.

Quantile<T>(Tensor<T>, Double, Tensor<Boolean>, Boolean)

Computes the quantile of the elements of a tensor.
C# 
public static T Quantile<T>(
	Tensor<T> operand,
	double probability,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false
)

Parameters

operand  Tensor<T>
The tensor that contains the elements to reduce.
probability  Double
A value between 0 and 1 that specifies the fraction of values that is smaller than the quantile.
mask  Tensor<Boolean>  (Optional)
Optional. A boolean that specifies for which elements the operation should be performed. If null (the default), the operation is applied everywhere.
skipMissingValues  Boolean  (Optional)
Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.

Type Parameters

T
The type of the elements of the tensor.

Return Value

T
The quantile of the elements of operand that satisfy mask.

Quantile<T>(Tensor<T>, Double, Axes, Tensor<T>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)

Computes the quantiles of the elements of a tensor along the specified axis.
C# 
public static Tensor<T> Quantile<T>(
	Tensor<T> operand,
	double probability,
	Axes axis,
	Tensor<T>? result = null,
	bool keepDimensions = false,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Parameters

operand  Tensor<T>
The tensor that contains the elements to reduce.
probability  Double
A value between 0 and 1 that specifies the fraction of values that is smaller than the quantile.
axis  Axes
The axis along which to reduce the elements.
result  Tensor<T>  (Optional)
Optional. The tensor that is to hold the result. May be null.
keepDimensions  Boolean  (Optional)
Optional. Specifies whether the reduced axis should be retained in the result. The default is false.
mask  Tensor<Boolean>  (Optional)
Optional. A boolean that specifies for which elements the operation should be performed. If null (the default), the operation is applied everywhere.
skipMissingValues  Boolean  (Optional)
Optional. Specifies whether missing values should be excluded from the aggregation. The default is false.
order  TensorElementOrder  (Optional)
Optional. Specifies the element order of the result. By default, elements are stored in the order of operand.

Type Parameters

T
The type of the elements of the tensor.

Return Value

Tensor<T>
A tensor containing the quantiles of the elements of operand that satisfy mask along axis.

See Also