TensorBackEnd.Modulus Method

Definition

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

Overload List

Modulus<T>(Tensor<T>, T, Tensor<T>, Tensor<Boolean>, TensorElementOrder)	Computes the remainder after dividing a tensor by a scalar.
Modulus<T>(Tensor<T>, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)	Returns the remainder after dividing one tensor by another.
Modulus<T>(T, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)	Computes the remainder after dividing a scalar by a tensor.

Modulus<T>(Tensor<T>, T, Tensor<T>, Tensor<Boolean>, TensorElementOrder)

Computes the remainder after dividing a tensor by a scalar.

public virtual Tensor<T> Modulus<T>(
	Tensor<T> left,
	T right,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Overridable Function Modulus(Of T) ( 
	left As Tensor(Of T),
	right As T,
	Optional result As Tensor(Of T) = Nothing,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
virtual Tensor<T>^ Modulus(
	Tensor<T>^ left, 
	T right, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract Modulus : 
        left : Tensor<'T> * 
        right : 'T * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T> 
override Modulus : 
        left : Tensor<'T> * 
        right : 'T * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T>

Parameters

left Tensor<T>: A tensor that serves as the left operand.
right T: A scalar that serves as the right operand.
result Tensor<T> (Optional): Optional. The tensor that is to hold the result. May be null.
mask Tensor<Boolean> (Optional): Optional. A boolean tensor that specifies for which elements the operation should be performed. If null (the default), the operation is applied everywhere.
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 of the same shape as left whose elements are equal to the modulus of the corresponding elements of left and right.

Exceptions

ArgumentNullException

left is null.

Modulus<T>(Tensor<T>, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)

Returns the remainder after dividing one tensor by another.

public virtual Tensor<T> Modulus<T>(
	Tensor<T> left,
	Tensor<T> right,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Overridable Function Modulus(Of T) ( 
	left As Tensor(Of T),
	right As Tensor(Of T),
	Optional result As Tensor(Of T) = Nothing,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
virtual Tensor<T>^ Modulus(
	Tensor<T>^ left, 
	Tensor<T>^ right, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract Modulus : 
        left : Tensor<'T> * 
        right : Tensor<'T> * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T> 
override Modulus : 
        left : Tensor<'T> * 
        right : Tensor<'T> * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T>

Parameters

left Tensor<T>: A tensor that serves as the left operand.
right Tensor<T>: A tensor that serves as the right operand.
result Tensor<T> (Optional): Optional. The tensor that is to hold the result. May be null.
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.
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 of the same shape as left and right whose elements are equal to the modulus of the corresponding elements of left and right.

Exceptions

ArgumentNullException

left is null.

-or-

right is null.

Modulus<T>(T, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)

Computes the remainder after dividing a scalar by a tensor.

public virtual Tensor<T> Modulus<T>(
	T left,
	Tensor<T> right,
	Tensor<T>? result = null,
	Tensor<bool>? mask = null,
	TensorElementOrder order = TensorElementOrder.Automatic
)

Visual Basic

Public Overridable Function Modulus(Of T) ( 
	left As T,
	right As Tensor(Of T),
	Optional result As Tensor(Of T) = Nothing,
	Optional mask As Tensor(Of Boolean) = Nothing,
	Optional order As TensorElementOrder = TensorElementOrder.Automatic
) As Tensor(Of T)

C++/CLI

public:
generic<typename T>
virtual Tensor<T>^ Modulus(
	T left, 
	Tensor<T>^ right, 
	Tensor<T>^ result = nullptr, 
	Tensor<bool>^ mask = nullptr, 
	TensorElementOrder order = TensorElementOrder::Automatic
)

abstract Modulus : 
        left : 'T * 
        right : Tensor<'T> * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T> 
override Modulus : 
        left : 'T * 
        right : Tensor<'T> * 
        ?result : Tensor<'T> * 
        ?mask : Tensor<bool> * 
        ?order : TensorElementOrder 
(* Defaults:
        let _result = defaultArg result null
        let _mask = defaultArg mask null
        let _order = defaultArg order TensorElementOrder.Automatic
*)
-> Tensor<'T>

Parameters

left T: A scalar that serves as the left operand.
right Tensor<T>: A tensor that serves as the right operand.
result Tensor<T> (Optional): Optional. The tensor that is to hold the result. May be null.
mask Tensor<Boolean> (Optional): Optional. A boolean tensor that specifies for which elements the operation should be performed. If null (the default), the operation is applied everywhere.
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 of the same shape as right whose elements are equal to the modulus of left and the corresponding elements of right.

Exceptions

ArgumentNullException

right is null.

TensorBackEnd.Modulus Method

Definition

Overload List

Modulus<T>(Tensor<T>, T, Tensor<T>, Tensor<Boolean>, TensorElementOrder)

Parameters

Type Parameters

Return Value

Exceptions

Modulus<T>(Tensor<T>, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)

Parameters

Type Parameters

Return Value

Exceptions

Modulus<T>(T, Tensor<T>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference