Tensor Back End.Left Shift Method
Definition
Namespace: Numerics.NET.Tensors
Assembly: Numerics.NET.Tensors (in Numerics.NET.Tensors.dll) Version: 9.0.1
Assembly: Numerics.NET.Tensors (in Numerics.NET.Tensors.dll) Version: 9.0.1
Overload List
Left | Shifts the elements of a tensor to the left. |
Left | Shifts the elements of a tensor to the left.. |
Left | Shifts a scalar to the left.. |
LeftShift<T>(Tensor<T>, Tensor<Int32>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)
Shifts the elements of a tensor to the left.
public virtual Tensor<T> LeftShift<T>(
Tensor<T> left,
Tensor<int> right,
Tensor<T>? result = null,
Tensor<bool>? mask = null,
TensorElementOrder order = TensorElementOrder.Automatic
)
Parameters
- left Tensor<T>
- A tensor that serves as the left operand.
- right Tensor<Int32>
- 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 shift of the corresponding elements of left and right.
Exceptions
Argument | left is null. -or- right is null. |
LeftShift<T>(Tensor<T>, Int32, Tensor<T>, Tensor<Boolean>, TensorElementOrder)
Shifts the elements of a tensor to the left..
public virtual Tensor<T> LeftShift<T>(
Tensor<T> left,
int right,
Tensor<T>? result = null,
Tensor<bool>? mask = null,
TensorElementOrder order = TensorElementOrder.Automatic
)
Parameters
- left Tensor<T>
- A tensor that serves as the left operand.
- right Int32
- 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 shift of the corresponding elements of left and right.
Exceptions
Argument | left is null. |
LeftShift<T>(T, Tensor<Int32>, Tensor<T>, Tensor<Boolean>, TensorElementOrder)
Shifts a scalar to the left..
public virtual Tensor<T> LeftShift<T>(
T left,
Tensor<int> right,
Tensor<T>? result = null,
Tensor<bool>? mask = null,
TensorElementOrder order = TensorElementOrder.Automatic
)
Parameters
- left T
- A scalar that serves as the left operand.
- right Tensor<Int32>
- 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 shift of left and the corresponding elements of right.
Exceptions
Argument | right is null. |