TensorBackEnd.Correlation Method

Definition

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

Overload List

Correlation<T>(Tensor<T>, Tensor<T>, Tensor<Boolean>, Boolean)	Computes the correlation of the corresponding elements of two tensors.
Correlation<T>(Tensor<T>, Tensor<T>, Axes, Tensor<T>, Boolean, Tensor<Boolean>, Boolean, TensorElementOrder)	Computes the correlation of the corresponding elements of two tensors.

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

Computes the correlation of the corresponding elements of two tensors.

public virtual T Correlation<T>(
	Tensor<T> tensor1,
	Tensor<T> tensor2,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false
)

Visual Basic

Public Overridable Function Correlation(Of T) ( 
	tensor1 As Tensor(Of T),
	tensor2 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 Correlation(
	Tensor<T>^ tensor1, 
	Tensor<T>^ tensor2, 
	Tensor<bool>^ mask = nullptr, 
	bool skipMissingValues = false
)

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

Parameters

tensor1 Tensor<T>: The tensor that serves as the first operand.
tensor2 Tensor<T>: The tensor that serves as the second operand.
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 tensors.

Return Value

T
A tensor containing the correlation of the elements of tensor1 and tensor2 that satisfy mask along the specified axis.

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

Computes the correlation of the corresponding elements of two tensors.

public virtual Tensor<T> Correlation<T>(
	Tensor<T> tensor1,
	Tensor<T> tensor2,
	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 Correlation(Of T) ( 
	tensor1 As Tensor(Of T),
	tensor2 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>^ Correlation(
	Tensor<T>^ tensor1, 
	Tensor<T>^ tensor2, 
	Axes axis, 
	Tensor<T>^ result = nullptr, 
	bool keepDimensions = false, 
	Tensor<bool>^ mask = nullptr, 
	bool skipMissingValues = false, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract Correlation : 
        tensor1 : Tensor<'T> * 
        tensor2 : 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 Correlation : 
        tensor1 : Tensor<'T> * 
        tensor2 : 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

tensor1 Tensor<T>: The tensor that serves as the first operand.
tensor2 Tensor<T>: The tensor that serves as the second operand.
axis Axes: The axis along which the correlation 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 tensors.

Return Value

Tensor<T>
A tensor containing the correlation of the elements of tensor1 and tensor2 that satisfy mask along the specified axis.

Exceptions

ArgumentNullException

tensor1 is null.

-or-

tensor2 is null.

TensorBackEnd.Correlation Method

Definition

Overload List

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

Parameters

Type Parameters

Return Value

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

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference