IntTensorOps

burn_tensor::ops

Trait IntTensorOps 

Source 
pub trait IntTensorOps<B: Backend> {

Show 103 methods    // Required methods
    fn int_empty(
        shape: Shape,
        device: &Device<B>,
        dtype: IntDType,
    ) -> IntTensor<B>;
    fn int_into_data(
        tensor: IntTensor<B>,
    ) -> impl Future<Output = TensorData> + Send;
    fn int_from_data(data: TensorData, device: &Device<B>) -> IntTensor<B>;
    fn int_device(tensor: &IntTensor<B>) -> Device<B>;
    fn int_to_device(tensor: IntTensor<B>, device: &Device<B>) -> IntTensor<B>;
    fn int_reshape(tensor: IntTensor<B>, shape: Shape) -> IntTensor<B>;
    fn int_slice(tensor: IntTensor<B>, slices: &[Slice]) -> IntTensor<B>;
    fn int_slice_assign(
        tensor: IntTensor<B>,
        slices: &[Slice],
        value: IntTensor<B>,
    ) -> IntTensor<B>;
    fn int_into_float(tensor: IntTensor<B>) -> FloatTensor<B>;
    fn int_mask_where(
        tensor: IntTensor<B>,
        mask: BoolTensor<B>,
        source: IntTensor<B>,
    ) -> IntTensor<B>;
    fn int_mask_fill(
        tensor: IntTensor<B>,
        mask: BoolTensor<B>,
        value: IntElem<B>,
    ) -> IntTensor<B>;
    fn int_gather(
        dim: usize,
        tensor: IntTensor<B>,
        indices: IntTensor<B>,
    ) -> IntTensor<B>;
    fn int_scatter(
        dim: usize,
        tensor: IntTensor<B>,
        indices: IntTensor<B>,
        value: IntTensor<B>,
    ) -> IntTensor<B>;
    fn int_select(
        tensor: IntTensor<B>,
        dim: usize,
        indices: IntTensor<B>,
    ) -> IntTensor<B>;
    fn int_select_assign(
        tensor: IntTensor<B>,
        dim: usize,
        indices: IntTensor<B>,
        value: IntTensor<B>,
    ) -> IntTensor<B>;
    fn int_equal(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>;
    fn int_equal_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>;
    fn int_greater(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>;
    fn int_greater_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>;
    fn int_greater_equal(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>;
    fn int_greater_equal_elem(
        lhs: IntTensor<B>,
        rhs: IntElem<B>,
    ) -> BoolTensor<B>;
    fn int_lower(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>;
    fn int_lower_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>;
    fn int_lower_equal(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>;
    fn int_lower_equal_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>;
    fn int_add(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn int_add_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>;
    fn int_sub(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn int_sub_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>;
    fn int_mul(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn int_mul_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>;
    fn int_div(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn int_div_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>;
    fn int_remainder(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn int_remainder_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>;
    fn int_matmul(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn int_sum(tensor: IntTensor<B>) -> IntTensor<B>;
    fn int_sum_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>;
    fn int_prod(tensor: IntTensor<B>) -> IntTensor<B>;
    fn int_prod_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>;
    fn int_mean_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>;
    fn int_cumsum(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>;
    fn int_cumprod(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>;
    fn int_cummin(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>;
    fn int_cummax(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>;
    fn int_argmax(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>;
    fn int_argmin(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>;
    fn int_abs(tensor: IntTensor<B>) -> IntTensor<B>;
    fn int_swap_dims(
        tensor: IntTensor<B>,
        dim1: usize,
        dim2: usize,
    ) -> IntTensor<B>;
    fn int_permute(tensor: IntTensor<B>, axes: &[usize]) -> IntTensor<B>;
    fn int_flip(tensor: IntTensor<B>, axes: &[usize]) -> IntTensor<B>;
    fn int_random(
        shape: Shape,
        distribution: Distribution,
        device: &Device<B>,
    ) -> IntTensor<B>;
    fn int_expand(tensor: IntTensor<B>, shape: Shape) -> IntTensor<B>;
    fn bitwise_and(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn bitwise_and_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>;
    fn bitwise_or(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn bitwise_or_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>;
    fn bitwise_xor(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn bitwise_xor_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>;
    fn bitwise_not(tensor: IntTensor<B>) -> IntTensor<B>;
    fn bitwise_left_shift(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn bitwise_left_shift_scalar(
        lhs: IntTensor<B>,
        rhs: IntElem<B>,
    ) -> IntTensor<B>;
    fn bitwise_right_shift(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>;
    fn bitwise_right_shift_scalar(
        lhs: IntTensor<B>,
        rhs: IntElem<B>,
    ) -> IntTensor<B>;
    fn int_cast(tensor: IntTensor<B>, dtype: IntDType) -> IntTensor<B>;
    fn int_unfold(
        tensor: IntTensor<B>,
        dim: usize,
        size: usize,
        step: usize,
    ) -> IntTensor<B>;

    // Provided methods
    fn int_repeat_dim(
        tensor: IntTensor<B>,
        dim: usize,
        times: usize,
    ) -> IntTensor<B> { ... }
    fn int_cat(tensors: Vec<IntTensor<B>>, dim: usize) -> IntTensor<B> { ... }
    fn int_not_equal(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B> { ... }
    fn int_not_equal_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B> { ... }
    fn int_powi(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B> { ... }
    fn int_powf(lhs: IntTensor<B>, rhs: FloatTensor<B>) -> IntTensor<B> { ... }
    fn int_powi_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B> { ... }
    fn int_powi_scalar_impl(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B> { ... }
    fn int_powf_scalar(lhs: IntTensor<B>, rhs: f32) -> IntTensor<B> { ... }
    fn int_powf_scalar_impl(lhs: IntTensor<B>, rhs: f32) -> IntTensor<B> { ... }
    fn int_clamp_min(tensor: IntTensor<B>, min: IntElem<B>) -> IntTensor<B> { ... }
    fn int_clamp_max(tensor: IntTensor<B>, max: IntElem<B>) -> IntTensor<B> { ... }
    fn int_clamp(
        tensor: IntTensor<B>,
        min: IntElem<B>,
        max: IntElem<B>,
    ) -> IntTensor<B> { ... }
    fn int_neg(tensor: IntTensor<B>) -> IntTensor<B> { ... }
    fn int_zeros(
        shape: Shape,
        device: &Device<B>,
        dtype: IntDType,
    ) -> IntTensor<B> { ... }
    fn int_ones(
        shape: Shape,
        device: &Device<B>,
        dtype: IntDType,
    ) -> IntTensor<B> { ... }
    fn int_full(
        shape: Shape,
        fill_value: IntElem<B>,
        device: &Device<B>,
        dtype: IntDType,
    ) -> IntTensor<B> { ... }
    fn int_mean(tensor: IntTensor<B>) -> IntTensor<B> { ... }
    fn int_max(tensor: IntTensor<B>) -> IntTensor<B> { ... }
    fn int_max_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B> { ... }
    fn int_max_dim_with_indices(
        tensor: IntTensor<B>,
        dim: usize,
    ) -> (IntTensor<B>, IntTensor<B>) { ... }
    fn int_max_abs(tensor: IntTensor<B>) -> IntTensor<B> { ... }
    fn int_max_abs_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B> { ... }
    fn int_min(tensor: IntTensor<B>) -> IntTensor<B> { ... }
    fn int_min_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B> { ... }
    fn int_min_dim_with_indices(
        tensor: IntTensor<B>,
        dim: usize,
    ) -> (IntTensor<B>, IntTensor<B>) { ... }
    fn int_transpose(tensor: IntTensor<B>) -> IntTensor<B> { ... }
    fn int_arange_step(
        range: Range<i64>,
        step: usize,
        device: &Device<B>,
    ) -> IntTensor<B> { ... }
    fn int_arange(range: Range<i64>, device: &Device<B>) -> IntTensor<B> { ... }
    fn int_any(tensor: IntTensor<B>) -> BoolTensor<B> { ... }
    fn int_any_dim(tensor: IntTensor<B>, dim: usize) -> BoolTensor<B> { ... }
    fn int_all(tensor: IntTensor<B>) -> BoolTensor<B> { ... }
    fn int_all_dim(tensor: IntTensor<B>, dim: usize) -> BoolTensor<B> { ... }
    fn int_sign(tensor: IntTensor<B>) -> IntTensor<B> { ... }
    fn int_sort(
        tensor: IntTensor<B>,
        dim: usize,
        descending: bool,
    ) -> IntTensor<B> { ... }
    fn int_sort_with_indices(
        tensor: IntTensor<B>,
        dim: usize,
        descending: bool,
    ) -> (IntTensor<B>, IntTensor<B>) { ... }
    fn int_argsort(
        tensor: IntTensor<B>,
        dim: usize,
        descending: bool,
    ) -> IntTensor<B> { ... }

}
Expand description

Int Tensor API for basic and numeric operations, see tensor for documentation on each function.

Required Methods§

Source

fn int_empty(shape: Shape, device: &Device<B>, dtype: IntDType) -> IntTensor<B>

Creates a new int tensor.

§Arguments
  • shape - The shape of the tensor.
  • device - The device to create the tensor on.
  • dtype - The target data type.
§Returns

The integer tensor with the given shape.

Source

fn int_into_data( tensor: IntTensor<B>, ) -> impl Future<Output = TensorData> + Send

Converts the tensor to a data structure.

§Arguments
  • tensor - The tensor.
§Returns

The data structure with the tensor’s data.

Source

fn int_from_data(data: TensorData, device: &Device<B>) -> IntTensor<B>

Creates a tensor from the data structure.

§Arguments
  • data - The data structure.
  • device - The device to create the tensor on.
§Returns

The tensor with the data.

Source

fn int_device(tensor: &IntTensor<B>) -> Device<B>

Gets the device of the tensor.

§Arguments
  • tensor - The tensor.
§Returns

The device of the tensor.

Source

fn int_to_device(tensor: IntTensor<B>, device: &Device<B>) -> IntTensor<B>

Moves the tensor to the given device.

Source

fn int_reshape(tensor: IntTensor<B>, shape: Shape) -> IntTensor<B>

Reshapes the tensor.

§Arguments
  • tensor - The tensor.
  • shape - The new shape.
§Returns

The tensor with the new shape.

Source

fn int_slice(tensor: IntTensor<B>, slices: &[Slice]) -> IntTensor<B>

Gets the element at the given indices.

§Arguments
  • tensor - The tensor.
  • slices - The slices specifying ranges and steps for each dimension.
§Returns

The elements at the given indices.

Source

fn int_slice_assign( tensor: IntTensor<B>, slices: &[Slice], value: IntTensor<B>, ) -> IntTensor<B>

Sets the values in the tensor for the given ranges.

§Arguments
  • tensor - The tensor.
  • ranges - The ranges to set the values for.
§Returns

The tensor with the values set for the given ranges.

Source

fn int_into_float(tensor: IntTensor<B>) -> FloatTensor<B>

Converts int tensor to float tensor.

§Arguments
  • tensor - The tensor.
§Returns

The int tensor with the same data as the float tensor.

Source

fn int_mask_where( tensor: IntTensor<B>, mask: BoolTensor<B>, source: IntTensor<B>, ) -> IntTensor<B>

Fills the tensor with values from the source tensor if the mask is true at the given indices.

§Arguments
  • tensor - The tensor.
  • mask - The mask.
  • source - The source tensor.
§Returns

The tensor with the values filled.

Source

fn int_mask_fill( tensor: IntTensor<B>, mask: BoolTensor<B>, value: IntElem<B>, ) -> IntTensor<B>

Fills the tensor with the given value if the mask is true at the given indices.

§Arguments
  • tensor - The tensor.
  • mask - The mask.
  • value - The value.
§Returns

The tensor with the values filled.

Source

fn int_gather( dim: usize, tensor: IntTensor<B>, indices: IntTensor<B>, ) -> IntTensor<B>

Gather elements from the tensor at the given indices.

§Arguments
  • dim - The dimension to gather from.
  • tensor - The tensor.
  • indices - The indices.
Source

fn int_scatter( dim: usize, tensor: IntTensor<B>, indices: IntTensor<B>, value: IntTensor<B>, ) -> IntTensor<B>

Scatter a given value to the tensor at the given indices.

§Arguments
  • dim - The dimension to scatter to.
  • tensor - The tensor.
  • indices - The indices.
  • value - The value.
§Returns

The tensor with the values scattered.

Source

fn int_select( tensor: IntTensor<B>, dim: usize, indices: IntTensor<B>, ) -> IntTensor<B>

Select tensor elements along the given dimension corresponding to the given indices.

§Arguments
  • tensor - The tensor.
  • dim - The dimension to select from.
  • indices - The indices.
§Returns

The tensor with the selected elements.

Source

fn int_select_assign( tensor: IntTensor<B>, dim: usize, indices: IntTensor<B>, value: IntTensor<B>, ) -> IntTensor<B>

Assign the selected elements along the given dimension corresponding to the given indices to the given value.

§Arguments
  • tensor - The tensor.
  • dim - The dimension to select from.
  • indices - The indices.
  • value - The value.
§Returns

The tensor with the selected elements assigned to the given value.

Source

fn int_equal(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>

Element-wise equality comparison.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_equal_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>

Element-wise equality comparison with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_greater(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>

Element-wise greater than comparison.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_greater_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>

Element-wise greater than comparison with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_greater_equal(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>

Element-wise greater than or equal comparison.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_greater_equal_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>

Element-wise greater than or equal comparison with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_lower(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>

Element-wise less than comparison.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_lower_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>

Element-wise less than comparison with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_lower_equal(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>

Element-wise less than or equal comparison.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_lower_equal_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>

Element-wise less than or equal comparison with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_add(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Element-wise addition.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The result of the addition.

Source

fn int_add_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Element-wise addition with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The result of the addition.

Source

fn int_sub(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Element-wise subtraction.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The result of the subtraction.

Source

fn int_sub_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Element-wise subtraction with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The result of the subtraction.

Source

fn int_mul(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Element-wise multiplication.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The result of the multiplication.

Source

fn int_mul_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Element-wise multiplication with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The result of the multiplication.

Source

fn int_div(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Element-wise division.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The result of the division.

Source

fn int_div_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Element-wise division with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The result of the division.

Source

fn int_remainder(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Element-wise modulus.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The result of applying the modulus of the scalar to the tensor.

Source

fn int_remainder_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Element-wise modulus with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The result of applying the modulus of the scalar to the tensor.

Source

fn int_matmul(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Multiplies two tensors together using matrix multiplication.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The result of multiplying the two tensors together using matrix multiplication.

Source

fn int_sum(tensor: IntTensor<B>) -> IntTensor<B>

Sums all elements in the tensor.

§Arguments
  • tensor - The tensor to sum.
§Returns

The sum of all elements in the tensor.

Source

fn int_sum_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Sums all elements in the tensor along a dimension.

§Arguments
  • tensor - The tensor to sum.
  • dim - The dimension to sum along.
§Returns

The sum of all elements in the tensor along the dimension.

Source

fn int_prod(tensor: IntTensor<B>) -> IntTensor<B>

Computes the product of all elements in the tensor.

§Arguments
  • tensor - The tensor to compute the product of.
§Returns

The product of all elements in the tensor.

Source

fn int_prod_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Computes the product of all elements in the tensor along a dimension.

§Arguments
  • tensor - The tensor to compute the product of.
  • dim - The dimension to compute the product along.
§Returns

The product of all elements in the tensor along the dimension.

Source

fn int_mean_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Computes the mean of all elements in the tensor along a dimension.

§Arguments
  • tensor - The tensor to compute the mean of.
§Returns

The mean of all elements in the tensor along the dimension.

Source

fn int_cumsum(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Computes the cumulative sum of elements along a dimension.

§Arguments
  • tensor - The tensor to compute the cumulative sum of.
  • dim - The dimension along which to compute the cumulative sum.
§Returns

A tensor with the same shape where each element is the cumulative sum of all elements up to and including that position along the dimension.

Source

fn int_cumprod(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Computes the cumulative product of elements along a dimension.

§Arguments
  • tensor - The tensor to compute the cumulative product of.
  • dim - The dimension along which to compute the cumulative product.
§Returns

A tensor with the same shape where each element is the cumulative product of all elements up to and including that position along the dimension.

Source

fn int_cummin(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Computes the cumulative minimum of elements along a dimension.

§Arguments
  • tensor - The tensor to compute the cumulative minimum of.
  • dim - The dimension along which to compute the cumulative minimum.
§Returns

A tensor with the same shape where each element is the minimum of all elements up to and including that position along the dimension.

Source

fn int_cummax(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Computes the cumulative maximum of elements along a dimension.

§Arguments
  • tensor - The tensor to compute the cumulative maximum of.
  • dim - The dimension along which to compute the cumulative maximum.
§Returns

A tensor with the same shape where each element is the maximum of all elements up to and including that position along the dimension.

Source

fn int_argmax(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Gets the indices of the maximum elements along a dimension.

§Arguments
  • tensor - The tensor to get the maximum indices of.
  • dim - The dimension to get the maximum indices along.
§Returns

The indices of the maximum elements along the dimension.

Source

fn int_argmin(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Gets the indices of the minimum elements along a dimension.

§Arguments
  • tensor - The tensor to get the minimum indices of.
  • dim - The dimension to get the minimum indices along.
§Returns

The indices of the minimum elements along the dimension.

Source

fn int_abs(tensor: IntTensor<B>) -> IntTensor<B>

Returns a new tensor with absolute values.

§Arguments
  • tensor - The tensor to take absolute value of.
§Returns

A tensor with the same shape as tensor with absolute values.

Source

fn int_swap_dims(tensor: IntTensor<B>, dim1: usize, dim2: usize) -> IntTensor<B>

Swaps two dimensions of an int tensor.

§Arguments
  • tensor - The tensor to swap the dimensions of.
  • dim1 - The first dimension to swap.
  • dim2 - The second dimension to swap.
§Returns

The tensor with the dimensions swapped.

Source

fn int_permute(tensor: IntTensor<B>, axes: &[usize]) -> IntTensor<B>

Permutes the dimensions of a tensor.

§Arguments
  • tensor - The tensor to permute the dimensions of.
  • axes - The new order of the dimensions.
§Returns

The tensor with the dimensions permuted.

Source

fn int_flip(tensor: IntTensor<B>, axes: &[usize]) -> IntTensor<B>

Reverse the order of elements in a tensor along the given axes.

§Arguments
  • tensor - The tensor to reverse.
  • axes - The axes to reverse.

The tensor with the elements reversed.

Source

fn int_random( shape: Shape, distribution: Distribution, device: &Device<B>, ) -> IntTensor<B>

Creates a new int tensor with random values.

§Arguments
  • shape - The shape of the tensor.
  • distribution - The distribution to sample from.
  • device - The device to create the tensor on.
§Returns

The tensor with the given shape and random values.

Source

fn int_expand(tensor: IntTensor<B>, shape: Shape) -> IntTensor<B>

Broadcasts the int tensor to the given shape.

Source

fn bitwise_and(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Bitwise AND operation for Int Tensors

Source

fn bitwise_and_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Bitwise AND operation for Int Tensors with a scalar

Source

fn bitwise_or(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Bitwise OR operation for Int Tensors

Source

fn bitwise_or_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Bitwise OR operation for Int Tensors with a scalar

Source

fn bitwise_xor(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Bitwise XOR operation for Int Tensors

Source

fn bitwise_xor_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Bitwise XOR operation for Int Tensors with a scalar

Source

fn bitwise_not(tensor: IntTensor<B>) -> IntTensor<B>

Bitwise NOT operation for Int Tensors

Source

fn bitwise_left_shift(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Bitwise left shift operation for Int Tensors

Source

fn bitwise_left_shift_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Bitwise left shift operation for Int Tensors with a scalar

Source

fn bitwise_right_shift(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Bitwise right shift operation for Int Tensors

Source

fn bitwise_right_shift_scalar( lhs: IntTensor<B>, rhs: IntElem<B>, ) -> IntTensor<B>

Bitwise right shift operation for Int Tensors with a scalar

Source

fn int_cast(tensor: IntTensor<B>, dtype: IntDType) -> IntTensor<B>

Converts a tensor to another integer data type.

§Arguments
  • tensor - The tensor to convert.
  • dtype - The target data type.
§Returns

A tensor with the same values as tensor but in the target integer data type.

Source

fn int_unfold( tensor: IntTensor<B>, dim: usize, size: usize, step: usize, ) -> IntTensor<B>

Unfold windows along a dimension.

Returns a view of the tensor with all complete windows of size size in dimension dim; where windows are advanced by step at each index.

The number of windows is max(0, (shape[dim] - size).ceil_div(step)).

§Arguments
  • tensor - The input tensor to unfold; of shape [pre=..., dim shape, post=...]
  • dim - the selected dim.
  • size - the size of each unfolded window.
  • step - the step between each window.
§Returns

A tensor view with shape [pre=..., windows, size, post=...].

Provided Methods§

Source

fn int_repeat_dim( tensor: IntTensor<B>, dim: usize, times: usize, ) -> IntTensor<B>

Repeats the tensor along the given dimension the given number of times.

§Arguments
  • tensor - The tensor.
  • dim - The dimension to repeat.
  • times - The number of times to repeat.
§Returns

The tensor with the given dimension repeated the given number of times.

Source

fn int_cat(tensors: Vec<IntTensor<B>>, dim: usize) -> IntTensor<B>

Concatenates the given tensors along the given dimension.

§Arguments
  • tensors - The tensors.
  • dim - The dimension to concatenate along.
§Returns

The concatenated tensor.

Source

fn int_not_equal(lhs: IntTensor<B>, rhs: IntTensor<B>) -> BoolTensor<B>

Element-wise non-equality comparison.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side tensor.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_not_equal_elem(lhs: IntTensor<B>, rhs: IntElem<B>) -> BoolTensor<B>

Element-wise non-equality comparison with a scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The boolean tensor with the result of the comparison.

Source

fn int_powi(lhs: IntTensor<B>, rhs: IntTensor<B>) -> IntTensor<B>

Element-wise power with a IntTensor.

§Arguments
  • lhs - The left-hand side IntTensor.
  • rhs - The right-hand side IntTensor.
§Returns

The elements of lhs raised to the power of the elements of rhs.

Source

fn int_powf(lhs: IntTensor<B>, rhs: FloatTensor<B>) -> IntTensor<B>

Element-wise power with a floatTensor.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side floatTensor.
§Returns

The elements of lhs raised to the value of rhs. Result is an IntTensor.

Source

fn int_powi_scalar(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Element-wise power with a scalar.

§Backend Implementors Note

A number of common exponent cases can be implemented with operations which are much cheaper than generic exponentiation.

This (Backend impl overridable) operation handles generic optimizations for several common integer exponent cases; and then dispatches to the (Backend impl overridable) Self::int_powi_scalar_impl operation to handle the generic case.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The elements of lhs raised to the value of rhs.

Source

fn int_powi_scalar_impl(lhs: IntTensor<B>, rhs: IntElem<B>) -> IntTensor<B>

Element-wise power with a scalar.

§Backend Implementors Note

This is the generic implementation of integer exponentiation called by Self::int_powi_scalar in the fallback case.

By default, this performs a relatively expensive conversion to float, exponentiation in float, and conversion back to int. This reduces the minimal operation set for Backends, at the cost of performance.

This is a good target for specialized optimizations in Backend implementations.

As a general rule, this should not be called directly.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The elements of lhs raised to the value of rhs.

Source

fn int_powf_scalar(lhs: IntTensor<B>, rhs: f32) -> IntTensor<B>

Element-wise power with a floatTensor.

Handles a number of special cases, then calls Self::int_powf_scalar_impl.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The elements of lhs raised to the value of rhs. Result is an IntTensor.

Source

fn int_powf_scalar_impl(lhs: IntTensor<B>, rhs: f32) -> IntTensor<B>

Element-wise power with a floatTensor.

Fallback handler for Self::int_powf_scalar.

§Arguments
  • lhs - The left-hand side tensor.
  • rhs - The right-hand side scalar.
§Returns

The elements of lhs raised to the value of rhs. Result is an IntTensor.

Source

fn int_clamp_min(tensor: IntTensor<B>, min: IntElem<B>) -> IntTensor<B>

Clamps a tensor under a minimum value.

§Arguments
  • tensor - The tensor to clamp.
  • min - The minimum value.
§Returns

The clamped tensor.

Source

fn int_clamp_max(tensor: IntTensor<B>, max: IntElem<B>) -> IntTensor<B>

Clamps a tensor over a maximum value.

§Arguments
  • tensor - The tensor to clamp.
  • max - The maximum value.
§Returns

The clamped tensor.

Source

fn int_clamp( tensor: IntTensor<B>, min: IntElem<B>, max: IntElem<B>, ) -> IntTensor<B>

Clamps a tensor between a minimum and maximum value.

§Arguments
  • tensor - The tensor to clamp.
  • min - The minimum value.
  • max - The maximum value.
§Returns

The clamped tensor.

Source

fn int_neg(tensor: IntTensor<B>) -> IntTensor<B>

Element-wise negation.

§Arguments
  • tensor - The tensor to negate.
§Returns

The negated tensor.

Source

fn int_zeros(shape: Shape, device: &Device<B>, dtype: IntDType) -> IntTensor<B>

Creates a tensor of zeros.

§Arguments
  • shape - The shape of the tensor.
  • device - The device to create the tensor on.
  • dtype - The target data type.
§Returns

The tensor of zeros.

Source

fn int_ones(shape: Shape, device: &Device<B>, dtype: IntDType) -> IntTensor<B>

Creates a tensor of ones.

§Arguments
  • shape - The shape of the tensor.
  • device - The device to create the tensor on.
  • dtype - The target data type.
§Returns

The tensor of ones.

Source

fn int_full( shape: Shape, fill_value: IntElem<B>, device: &Device<B>, dtype: IntDType, ) -> IntTensor<B>

Creates a tensor filled with given value.

§Arguments
  • shape - The shape of the tensor.
  • fill_value - The value with which to fill the tensor.
  • device - The device to create the tensor on.
  • dtype - The target data type.
§Returns

The tensor filled with given value

Source

fn int_mean(tensor: IntTensor<B>) -> IntTensor<B>

Computes the mean of all elements in the tensor.

§Arguments
  • tensor - The tensor to compute the mean of.
§Returns

The mean of all elements in the tensor.

Source

fn int_max(tensor: IntTensor<B>) -> IntTensor<B>

Gets the maximum element in the tensor.

§Arguments
  • tensor - The tensor to get the maximum element of.
§Returns

The maximum element in the tensor.

Source

fn int_max_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Gets the maximum element in the tensor along a dimension.

§Arguments
  • tensor - The tensor to get the maximum element of.
  • dim - The dimension to get the maximum element along.
§Returns

The maximum element in the tensor along the dimension.

Source

fn int_max_dim_with_indices( tensor: IntTensor<B>, dim: usize, ) -> (IntTensor<B>, IntTensor<B>)

Gets the maximum elements and corresponding indices along a dimension.

§Arguments
  • tensor - The tensor to get the maximum elements and indices of.
  • dim - The dimension to get the maximum elements and indices along.
§Returns

The maximum elements and corresponding indices along the dimension.

Source

fn int_max_abs(tensor: IntTensor<B>) -> IntTensor<B>

Gets the maximum absolute element in the tensor.

§Arguments
  • tensor - The tensor to get the maximum element of.
§Returns

The maximum element in the tensor.

Source

fn int_max_abs_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Gets the maximum absolute element in the tensor along a dimension.

§Arguments
  • tensor - The tensor to get the maximum element of.
  • dim - The dimension to get the maximum element along.
§Returns

The maximum element in the tensor along the dimension.

Source

fn int_min(tensor: IntTensor<B>) -> IntTensor<B>

Gets the minimum element in the tensor.

§Arguments
  • tensor - The tensor to get the minimum element of.
§Returns

The minimum element in the tensor.

Source

fn int_min_dim(tensor: IntTensor<B>, dim: usize) -> IntTensor<B>

Gets the minimum elements in the tensor along a dimension.

§Arguments
  • tensor - The tensor to get the minimum element of.
  • dim - The dimension to get the minimum element along.
§Returns

The minimum element in the tensor along the dimension.

Source

fn int_min_dim_with_indices( tensor: IntTensor<B>, dim: usize, ) -> (IntTensor<B>, IntTensor<B>)

Gets the minimum elements and corresponding indices along a dimension.

§Arguments
  • tensor - The tensor to get the minimum elements and indices of.
  • dim - The dimension to get the minimum elements and indices along.
§Returns

The minimum elements and corresponding indices along the dimension.

Source

fn int_transpose(tensor: IntTensor<B>) -> IntTensor<B>

Transposes an int tensor.

§Arguments
  • tensor - The tensor to transpose.
§Returns

The transposed tensor.

Source

fn int_arange_step( range: Range<i64>, step: usize, device: &Device<B>, ) -> IntTensor<B>

Creates a new tensor with values from the given range with the given step size.

§Arguments
  • range - The range of values.
  • step - The step size.
  • device - The device to create the tensor on.
§Returns

The tensor with the given values.

Source

fn int_arange(range: Range<i64>, device: &Device<B>) -> IntTensor<B>

Creates a new tensor with values from the given range.

§Arguments
  • range - The range of values.
  • device - The device to create the tensor on.
§Returns

The tensor with the given values.

§Remarks

Uses arange_step with a step size of 1 under the hood.

Source

fn int_any(tensor: IntTensor<B>) -> BoolTensor<B>

Tests if any element in the int tensor evaluates to True.

§Arguments
  • tensor - The tensor to test.
§Returns

A boolean tensor with a single element, True if any element in the tensor is True, False otherwise.

Source

fn int_any_dim(tensor: IntTensor<B>, dim: usize) -> BoolTensor<B>

Tests if any element in the int tensor evaluates to True along a given dimension dim.

§Arguments
  • tensor - The tensor to test.
  • dim - The axis along which to test.
§Returns

A boolean tensor Tensor<B, D, Bool> with the same size as input tensor, except in the dim axis where the size is 1. The elem in the dim axis is True if any element along this dim in the input evaluates to True, False otherwise.

Source

fn int_all(tensor: IntTensor<B>) -> BoolTensor<B>

Tests if all elements in the int tensor evaluate to True.

§Arguments
  • tensor - The tensor to test.
§Returns

A boolean tensor Tensor<B, 1, Bool> with a single element, True if all elements in the input tensor evaluate to True, False otherwise.

Source

fn int_all_dim(tensor: IntTensor<B>, dim: usize) -> BoolTensor<B>

Tests if all elements in the int tensor evaluate to True along a given dimension dim.

§Arguments
  • tensor - The tensor to test.
  • dim - The axis along which to test.
§Returns

A boolean tensor Tensor<B, D, Bool> with the same size as input tensor, except in the dim axis where the size is 1. The elem in the dim axis is True if all elements along this dim in the input evaluates to True, False otherwise.

Source

fn int_sign(tensor: IntTensor<B>) -> IntTensor<B>

Returns the signs of the int tensor.

§Arguments
  • tensor - The tensor to extract the signs from.
§Returns

A tensor with the same shape as tensor containing the signs of the elements of tensor.

Source

fn int_sort(tensor: IntTensor<B>, dim: usize, descending: bool) -> IntTensor<B>

Sort the elements of the input tensor by value along a given dimension.

This sort is unstable (i.e., may reorder equal elements).

§Arguments
  • tensor - The input tensor.
  • dim - The axis along which to sort.
  • descending - The sorting order.
§Returns

A tensor with the same shape as the input tensor, where the elements are sorted by value.

Source

fn int_sort_with_indices( tensor: IntTensor<B>, dim: usize, descending: bool, ) -> (IntTensor<B>, IntTensor<B>)

Sort the elements of the input tensor by value along a given dimension.

This sort is unstable (i.e., may reorder equal elements).

§Arguments
  • tensor - The input tensor.
  • dim - The axis along which to sort.
§Returns

A tensor with the same shape as the input tensor and corresponding indices, where the elements are sorted by value and the indices map back to the original input tensor.

Source

fn int_argsort( tensor: IntTensor<B>, dim: usize, descending: bool, ) -> IntTensor<B>

Returns the indices that sort the elements of the input tensor by value along a given dimension.

This sort is unstable (i.e., may reorder equal elements).

§Arguments
  • tensor - The input tensor.
  • dim - The axis along which to sort.
  • descending - The sorting order.
§Returns

A tensor with the same shape as the input tensor the indices map back to the original input tensor.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§