TensorBackEnd.OneNorm Method

Definition

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

Overload List

OneNorm<T>(Tensor<T>, Tensor<Boolean>, Boolean)	Computes the sum of the absolute values of the elements of a tensor.
OneNorm<T>(Tensor<T>, Axes, Tensor<T>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)	Computes the sum of the absolute values of the elements of a tensor.

OneNorm<T>(Tensor<T>, Tensor<Boolean>, Boolean)

Computes the sum of the absolute values of the elements of a tensor.

public virtual T OneNorm<T>(
	Tensor<T> value,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false
)

Visual Basic

Public Overridable Function OneNorm(Of T) ( 
	value As Tensor(Of T),
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional skipMissingValues As Boolean = false
) As T

C++/CLI

public:
generic<typename T>
virtual T OneNorm(
	Tensor<T>^ value, 
	Tensor<bool>^ mask = nullptr, 
	bool skipMissingValues = false
)

abstract OneNorm : 
        value : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'T 
override OneNorm : 
        value : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool 
(* Defaults:
        let _mask = defaultArg mask null
        let _skipMissingValues = defaultArg skipMissingValues false
*)
-> 'T

Parameters

value Tensor<T>: A tensor.
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
A tensor containing the sum of the absolute values of the elements of value that satisfy mask along the specified axis.

OneNorm<T>(Tensor<T>, Axes, Tensor<T>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)

Computes the sum of the absolute values of the elements of a tensor.

public virtual Tensor<T> OneNorm<T>(
	Tensor<T> value,
	Axes axis,
	Tensor<T>? result = null,
	bool keepDimensions = false,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Overridable Function OneNorm(Of T) ( 
	value As Tensor(Of T),
	axis As Axes,
	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>^ OneNorm(
	Tensor<T>^ value, 
	Axes axis, 
	Tensor<T>^ result = nullptr, 
	bool keepDimensions = false, 
	Tensor<bool>^ mask = nullptr, 
	bool skipMissingValues = false, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract OneNorm : 
        value : Tensor<'T> * 
        axis : Axes * 
        ?result : Tensor<'T> * 
        ?keepDimensions : bool * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool * 
        ?order : TensorElementOrder 
(* Defaults:
        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 OneNorm : 
        value : Tensor<'T> * 
        axis : Axes * 
        ?result : Tensor<'T> * 
        ?keepDimensions : bool * 
        ?mask : Tensor<bool> * 
        ?skipMissingValues : bool * 
        ?order : TensorElementOrder 
(* Defaults:
        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

value Tensor<T>: A tensor.
axis Axes: The axis along which the sum of the absolute values of the elements is computed.
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 tensor that specifies for which elements should be included in the operation. If null (the default), the operation is applied everywhere.
skipMissingValues Boolean (Optional): Optional. Specifies whether missing values should be excluded from the operation. The default is false.
order TensorElementOrder (Optional): Optional. If result is null, the desired ordering in memory of the result.

Type Parameters

T: The type of the elements of the tensor.

Return Value

Tensor<T>
A tensor containing the sum of the absolute values of the elements of value that satisfy mask along the specified axis.

Exceptions

ArgumentNullException

value is null.

TensorBackEnd.OneNorm Method

Definition

Overload List

OneNorm<T>(Tensor<T>, Tensor<Boolean>, Boolean)

Parameters

Type Parameters

Return Value

OneNorm<T>(Tensor<T>, Axes, Tensor<T>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference