TensorBackEnd.Percentile Method

Definition

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

Overload List

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

Percentile<T>(Tensor<T>, Double, QuantileType, Tensor<Boolean>, Boolean)

Computes the quantile of the elements of a tensor.
C#
public virtual T Percentile<T>(
	Tensor<T> operand,
	double percentage,
	QuantileType type = QuantileType.Default,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false
)

Parameters

operand  Tensor<T>
The tensor that contains the elements to reduce.
percentage  Double
A value between 0 and 100 that specifies the percentage of values that is smaller than the quantile.
type  QuantileType  (Optional)
Optional. The type of percentile to compute. The type corresponds to the argument of the same type to the quantile function in R. The default is linear.
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.

Percentile<T>(Tensor<T>, Double, Axes, QuantileType, Tensor<T>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)

Computes the percentiles of the elements of a tensor along the specified axis.
C#
public virtual Tensor<T> Percentile<T>(
	Tensor<T> operand,
	double percentage,
	Axes axis,
	QuantileType type = QuantileType.Default,
	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.
percentage  Double
A value between 0 and 100 that specifies the percentage of values that is smaller than the quantile.
axis  Axes
The axis along which to reduce the elements.
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.
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 percentiles of the elements of operand that satisfy mask along axis.

See Also