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.

public virtual T Percentile<T>(
	Tensor<T> operand,
	double percentage,
	QuantileType type = QuantileType.R,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false
)

Visual Basic

Public Overridable Function Percentile(Of T) ( 
	operand As Tensor(Of T),
	percentage As Double,
	Optional type As QuantileType = QuantileType.R,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional skipMissingValues As Boolean = false
) As T

C++/CLI

public:
generic<typename T>
virtual T Percentile(
	Tensor<T>^ operand, 
	double percentage, 
	QuantileType type = QuantileType::R, 
	Tensor<bool>^ mask = nullptr, 
	bool skipMissingValues = false
)

abstract Percentile : 
        operand : Tensor<'T> * 
        percentage : float * 
        ?type : QuantileType * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _type = defaultArg type QuantileType.R
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'T 
override Percentile : 
        operand : Tensor<'T> * 
        percentage : float * 
        ?type : QuantileType * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _type = defaultArg type QuantileType.R
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'T

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.

public virtual Tensor<T> Percentile<T>(
	Tensor<T> operand,
	double percentage,
	Axes axis,
	QuantileType type = QuantileType.R,
	Tensor<T>? result = null,
	bool keepDimensions = false,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Overridable Function Percentile(Of T) ( 
	operand As Tensor(Of T),
	percentage As Double,
	axis As Axes,
	Optional type As QuantileType = QuantileType.R,
	Optional result As Tensor(Of T) = Nothing,
	Optional keepDimensions As Boolean = false,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional skipMissingValues As Boolean = false,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
virtual Tensor<T>^ Percentile(
	Tensor<T>^ operand, 
	double percentage, 
	Axes axis, 
	QuantileType type = QuantileType::R, 
	Tensor<T>^ result = nullptr, 
	bool keepDimensions = false, 
	Tensor<bool>^ mask = nullptr, 
	bool skipMissingValues = false, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract Percentile : 
        operand : Tensor<'T> * 
        percentage : float * 
        axis : Axes * 
        ?type : QuantileType * 
        ?result : Tensor<'T> * 
        ?keepDimensions : bool * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool * 
        ?order : TensorElementOrder 
(* Defaults:
        let _type = defaultArg type QuantileType.R
        let _result = defaultArg result null
        let _keepDimensions = defaultArg keepDimensions false
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T> 
override Percentile : 
        operand : Tensor<'T> * 
        percentage : float * 
        axis : Axes * 
        ?type : QuantileType * 
        ?result : Tensor<'T> * 
        ?keepDimensions : bool * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool * 
        ?order : TensorElementOrder 
(* Defaults:
        let _type = defaultArg type QuantileType.R
        let _result = defaultArg result null
        let _keepDimensions = defaultArg keepDimensions false
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T>

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.

TensorBackEnd.Percentile Method

Definition

Overload List

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

Parameters

Type Parameters

Return Value

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

Parameters

Type Parameters

Return Value

See Also

Reference