Tensor.Quantiles<T> Method

Computes the quantiles of the elements of a tensor along the specified axis.

Definition

Namespace: Numerics.NET.Tensors
Assembly: Numerics.NET.Tensors (in Numerics.NET.Tensors.dll) Version: 9.0.3
C#
public static Tensor<T> Quantiles<T>(
	Tensor<T> operand,
	IEnumerable<double> probabilities,
	Axes axis,
	QuantileType type = QuantileType.Default,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Parameters

operand  Tensor<T>
The tensor that contains the elements to reduce.
probabilities  IEnumerable<Double>
A sequence of values between 0 and 1 that specifies the fraction of values that is smaller than the quantile.
axis  Axes
The axis along which to compute the quantiles.
type  QuantileType  (Optional)
Optional. The type of quantile to compute. The type corresponds to the argument of the same type to the quantile function in R. The default is linear.
result  Tensor<T>  (Optional)
Optional. The tensor that is to hold the result. May be null.
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