Tensor.Correlation Method

Definition

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

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.
C# 
public static T Correlation<T>(
	Tensor<T> tensor1,
	Tensor<T> tensor2,
	Tensor<bool>? mask = null,
	bool skipMissingValues = false
)

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 tensor.

Return Value

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

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

Computes the correlation of the corresponding elements of two tensors.
C# 
public static Tensor<T> Correlation<T>(
	this 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
)

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 aggregation. 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 correlation of the elements of tensor1 and tensor2 that satisfy mask along the specified axis.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Tensor<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentNullException

tensor1 is null.

-or-

tensor2 is null.

See Also