Trait burn_tensor::ops::IntTensorOps

source · 
pub trait IntTensorOps<B: Backend> {

Show 84 methods    // Required methods
    fn int_empty<const D: usize>(
        shape: Shape<D>,
        device: &Device<B>,
    ) -> IntTensor<B, D>;
    fn int_shape<const D: usize>(tensor: &IntTensor<B, D>) -> Shape<D>;
    fn int_into_data<const D: usize>(
        tensor: IntTensor<B, D>,
    ) -> impl Future<Output = TensorData> + Send;
    fn int_from_data<const D: usize>(
        data: TensorData,
        device: &Device<B>,
    ) -> IntTensor<B, D>;
    fn int_device<const D: usize>(tensor: &IntTensor<B, D>) -> Device<B>;
    fn int_to_device<const D: usize>(
        tensor: IntTensor<B, D>,
        device: &Device<B>,
    ) -> IntTensor<B, D>;
    fn int_reshape<const D1: usize, const D2: usize>(
        tensor: IntTensor<B, D1>,
        shape: Shape<D2>,
    ) -> IntTensor<B, D2>;
    fn int_slice<const D1: usize, const D2: usize>(
        tensor: IntTensor<B, D1>,
        indices: [Range<usize>; D2],
    ) -> IntTensor<B, D1>;
    fn int_slice_assign<const D1: usize, const D2: usize>(
        tensor: IntTensor<B, D1>,
        indices: [Range<usize>; D2],
        value: IntTensor<B, D1>,
    ) -> IntTensor<B, D1>;
    fn int_into_float<const D: usize>(
        tensor: IntTensor<B, D>,
    ) -> FloatTensor<B, D>;
    fn int_mask_where<const D: usize>(
        tensor: IntTensor<B, D>,
        mask: BoolTensor<B, D>,
        source: IntTensor<B, D>,
    ) -> IntTensor<B, D>;
    fn int_mask_fill<const D: usize>(
        tensor: IntTensor<B, D>,
        mask: BoolTensor<B, D>,
        value: IntElem<B>,
    ) -> IntTensor<B, D>;
    fn int_gather<const D: usize>(
        dim: usize,
        tensor: IntTensor<B, D>,
        indices: IntTensor<B, D>,
    ) -> IntTensor<B, D>;
    fn int_scatter<const D: usize>(
        dim: usize,
        tensor: IntTensor<B, D>,
        indices: IntTensor<B, D>,
        value: IntTensor<B, D>,
    ) -> IntTensor<B, D>;
    fn int_select<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
        indices: IntTensor<B, 1>,
    ) -> IntTensor<B, D>;
    fn int_select_assign<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
        indices: IntTensor<B, 1>,
        value: IntTensor<B, D>,
    ) -> IntTensor<B, D>;
    fn int_equal<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> BoolTensor<B, D>;
    fn int_equal_elem<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> BoolTensor<B, D>;
    fn int_greater<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> BoolTensor<B, D>;
    fn int_greater_elem<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> BoolTensor<B, D>;
    fn int_greater_equal<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> BoolTensor<B, D>;
    fn int_greater_equal_elem<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> BoolTensor<B, D>;
    fn int_lower<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> BoolTensor<B, D>;
    fn int_lower_elem<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> BoolTensor<B, D>;
    fn int_lower_equal<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> BoolTensor<B, D>;
    fn int_lower_equal_elem<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> BoolTensor<B, D>;
    fn int_add<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> IntTensor<B, D>;
    fn int_add_scalar<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> IntTensor<B, D>;
    fn int_sub<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> IntTensor<B, D>;
    fn int_sub_scalar<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> IntTensor<B, D>;
    fn int_mul<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> IntTensor<B, D>;
    fn int_mul_scalar<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> IntTensor<B, D>;
    fn int_div<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> IntTensor<B, D>;
    fn int_div_scalar<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> IntTensor<B, D>;
    fn int_remainder_scalar<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> IntTensor<B, D>;
    fn int_zeros<const D: usize>(
        shape: Shape<D>,
        device: &Device<B>,
    ) -> IntTensor<B, D>;
    fn int_ones<const D: usize>(
        shape: Shape<D>,
        device: &Device<B>,
    ) -> IntTensor<B, D>;
    fn int_sum<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1>;
    fn int_sum_dim<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> IntTensor<B, D>;
    fn int_prod<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1>;
    fn int_prod_dim<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> IntTensor<B, D>;
    fn int_mean_dim<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> IntTensor<B, D>;
    fn int_argmax<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> IntTensor<B, D>;
    fn int_argmin<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> IntTensor<B, D>;
    fn int_abs<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, D>;
    fn int_swap_dims<const D: usize>(
        tensor: IntTensor<B, D>,
        dim1: usize,
        dim2: usize,
    ) -> IntTensor<B, D>;
    fn int_permute<const D: usize>(
        tensor: IntTensor<B, D>,
        axes: [usize; D],
    ) -> IntTensor<B, D>;
    fn int_flip<const D: usize>(
        tensor: IntTensor<B, D>,
        axes: &[usize],
    ) -> IntTensor<B, D>;
    fn int_random<const D: usize>(
        shape: Shape<D>,
        distribution: Distribution,
        device: &Device<B>,
    ) -> IntTensor<B, D>;
    fn int_expand<const D1: usize, const D2: usize>(
        tensor: IntTensor<B, D1>,
        shape: Shape<D2>,
    ) -> IntTensor<B, D2>;

    // Provided methods
    fn int_repeat_dim<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
        times: usize,
    ) -> IntTensor<B, D> { ... }
    fn int_cat<const D: usize>(
        tensors: Vec<IntTensor<B, D>>,
        dim: usize,
    ) -> IntTensor<B, D> { ... }
    fn int_not_equal<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> BoolTensor<B, D> { ... }
    fn int_not_equal_elem<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> BoolTensor<B, D> { ... }
    fn int_powi<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntTensor<B, D>,
    ) -> IntTensor<B, D> { ... }
    fn int_powf<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: FloatTensor<B, D>,
    ) -> IntTensor<B, D> { ... }
    fn int_powi_scalar<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: IntElem<B>,
    ) -> IntTensor<B, D> { ... }
    fn int_powf_scalar<const D: usize>(
        lhs: IntTensor<B, D>,
        rhs: f32,
    ) -> IntTensor<B, D> { ... }
    fn int_clamp_min<const D: usize>(
        tensor: IntTensor<B, D>,
        min: IntElem<B>,
    ) -> IntTensor<B, D> { ... }
    fn int_clamp_max<const D: usize>(
        tensor: IntTensor<B, D>,
        max: IntElem<B>,
    ) -> IntTensor<B, D> { ... }
    fn int_clamp<const D: usize>(
        tensor: IntTensor<B, D>,
        min: IntElem<B>,
        max: IntElem<B>,
    ) -> IntTensor<B, D> { ... }
    fn int_neg<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, D> { ... }
    fn int_full<const D: usize>(
        shape: Shape<D>,
        fill_value: IntElem<B>,
        device: &Device<B>,
    ) -> IntTensor<B, D> { ... }
    fn int_mean<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1> { ... }
    fn int_max<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1> { ... }
    fn int_max_dim<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> IntTensor<B, D> { ... }
    fn int_max_dim_with_indices<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> (IntTensor<B, D>, IntTensor<B, D>) { ... }
    fn int_min<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1> { ... }
    fn int_min_dim<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> IntTensor<B, D> { ... }
    fn int_min_dim_with_indices<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> (IntTensor<B, D>, IntTensor<B, D>) { ... }
    fn int_transpose<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, D> { ... }
    fn int_narrow<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
        start: usize,
        length: usize,
    ) -> IntTensor<B, D> { ... }
    fn int_cartesian_grid<S: Into<Shape<D>>, const D: usize, const D2: usize>(
        shape: S,
        device: &B::Device,
    ) -> IntTensor<B, D2> { ... }
    fn int_chunk<const D: usize>(
        tensor: IntTensor<B, D>,
        chunks: usize,
        dim: usize,
    ) -> Vec<IntTensor<B, D>> { ... }
    fn int_arange_step(
        range: Range<i64>,
        step: usize,
        device: &Device<B>,
    ) -> IntTensor<B, 1> { ... }
    fn int_arange(range: Range<i64>, device: &Device<B>) -> IntTensor<B, 1> { ... }
    fn int_any<const D: usize>(tensor: IntTensor<B, D>) -> BoolTensor<B, 1> { ... }
    fn int_any_dim<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> BoolTensor<B, D> { ... }
    fn int_all<const D: usize>(tensor: IntTensor<B, D>) -> BoolTensor<B, 1> { ... }
    fn int_all_dim<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
    ) -> BoolTensor<B, D> { ... }
    fn int_sign<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, D> { ... }
    fn int_sort<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
        descending: bool,
    ) -> IntTensor<B, D> { ... }
    fn int_sort_with_indices<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
        descending: bool,
    ) -> (IntTensor<B, D>, IntTensor<B, D>) { ... }
    fn int_argsort<const D: usize>(
        tensor: IntTensor<B, D>,
        dim: usize,
        descending: bool,
    ) -> IntTensor<B, D> { ... }

}
Expand description

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

Required Methods§

source

fn int_empty<const D: usize>( shape: Shape<D>, device: &Device<B>, ) -> IntTensor<B, D>

Creates a new int tensor.

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

The integer tensor with the given shape.

source

fn int_shape<const D: usize>(tensor: &IntTensor<B, D>) -> Shape<D>

Returns the shape of the tensor.

§Arguments
  • tensor - The tensor.
§Returns

The shape of the tensor.

source

fn int_into_data<const D: usize>( tensor: IntTensor<B, D>, ) -> 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<const D: usize>( data: TensorData, device: &Device<B>, ) -> IntTensor<B, D>

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<const D: usize>(tensor: &IntTensor<B, D>) -> Device<B>

Gets the device of the tensor.

§Arguments
  • tensor - The tensor.
§Returns

The device of the tensor.

source

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

Moves the tensor to the given device.

source

fn int_reshape<const D1: usize, const D2: usize>( tensor: IntTensor<B, D1>, shape: Shape<D2>, ) -> IntTensor<B, D2>

Reshapes the tensor.

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

The tensor with the new shape.

source

fn int_slice<const D1: usize, const D2: usize>( tensor: IntTensor<B, D1>, indices: [Range<usize>; D2], ) -> IntTensor<B, D1>

Gets the element at the given indices.

§Arguments
  • tensor - The tensor.
  • indices - The indices.
§Returns

The elements at the given indices.

source

fn int_slice_assign<const D1: usize, const D2: usize>( tensor: IntTensor<B, D1>, indices: [Range<usize>; D2], value: IntTensor<B, D1>, ) -> IntTensor<B, D1>

Sets the element at the given indices.

§Arguments
  • tensor - The tensor.
  • indices - The indices.
§Returns

The tensor with the element at the given indices set.

source

fn int_into_float<const D: usize>(tensor: IntTensor<B, D>) -> FloatTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, mask: BoolTensor<B, D>, source: IntTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, mask: BoolTensor<B, D>, value: IntElem<B>, ) -> IntTensor<B, D>

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<const D: usize>( dim: usize, tensor: IntTensor<B, D>, indices: IntTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( dim: usize, tensor: IntTensor<B, D>, indices: IntTensor<B, D>, value: IntTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, indices: IntTensor<B, 1>, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, indices: IntTensor<B, 1>, value: IntTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> IntTensor<B, D>

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_scalar<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> IntTensor<B, D>

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_zeros<const D: usize>( shape: Shape<D>, device: &Device<B>, ) -> IntTensor<B, D>

Creates a tensor of zeros.

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

The tensor of zeros.

source

fn int_ones<const D: usize>( shape: Shape<D>, device: &Device<B>, ) -> IntTensor<B, D>

Creates a tensor of ones.

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

The tensor of ones.

source

fn int_sum<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> IntTensor<B, D>

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<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> IntTensor<B, D>

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_argmax<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> IntTensor<B, D>

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<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, dim1: usize, dim2: usize, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, axes: [usize; D], ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, axes: &[usize], ) -> IntTensor<B, D>

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<const D: usize>( shape: Shape<D>, distribution: Distribution, device: &Device<B>, ) -> IntTensor<B, D>

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<const D1: usize, const D2: usize>( tensor: IntTensor<B, D1>, shape: Shape<D2>, ) -> IntTensor<B, D2>

Broadcasts the int tensor to the given shape.

Provided Methods§

source

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

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<const D: usize>( tensors: Vec<IntTensor<B, D>>, dim: usize, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> BoolTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: FloatTensor<B, D>, ) -> IntTensor<B, D>

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<const D: usize>( lhs: IntTensor<B, D>, rhs: IntElem<B>, ) -> IntTensor<B, D>

Element-wise power with a 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.

source

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

Element-wise power with a floatTensor.

§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<const D: usize>( tensor: IntTensor<B, D>, min: IntElem<B>, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, max: IntElem<B>, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, min: IntElem<B>, max: IntElem<B>, ) -> IntTensor<B, D>

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<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, D>

Element-wise negation.

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

The negated tensor.

source

fn int_full<const D: usize>( shape: Shape<D>, fill_value: IntElem<B>, device: &Device<B>, ) -> IntTensor<B, D>

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.
§Returns

The tensor filled with given value

source

fn int_mean<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1>

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<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> (IntTensor<B, D>, IntTensor<B, D>)

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_min<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, 1>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> (IntTensor<B, D>, IntTensor<B, D>)

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<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, D>

Transposes an int tensor.

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

The transposed tensor.

source

fn int_narrow<const D: usize>( tensor: IntTensor<B, D>, dim: usize, start: usize, length: usize, ) -> IntTensor<B, D>

Returns a new tensor with the given dimension narrowed to the given range.

§Arguments
  • dim - The dimension along which the tensor will be narrowed.
  • start - The starting point of the given range.
  • length - The ending point of the given range.
§Panics
  • If the dimension is greater than the number of dimensions of the tensor.
  • If the given range exceeds the number of elements on the given dimension.
§Returns

A new tensor with the given dimension narrowed to the given range.

source

fn int_cartesian_grid<S: Into<Shape<D>>, const D: usize, const D2: usize>( shape: S, device: &B::Device, ) -> IntTensor<B, D2>

Generates a cartesian grid for the given tensor shape on the specified device. The generated tensor is of dimension D2 = D + 1, where each element at dimension D contains the cartesian grid coordinates for that element.

§Arguments
  • shape - The shape specifying the dimensions of the tensor.
  • device - The device to create the tensor on.
§Panics

Panics if D2 is not equal to D+1.

§Examples
   use burn_tensor::Int;
   use burn_tensor::{backend::Backend, Shape, Tensor};
   fn example<B: Backend>() {
       let device = Default::default();
       let result: Tensor<B, 3, _> = Tensor::<B, 2, Int>::cartesian_grid([2, 3], &device);
       println!("{}", result);
   }
source

fn int_chunk<const D: usize>( tensor: IntTensor<B, D>, chunks: usize, dim: usize, ) -> Vec<IntTensor<B, D>>

Split the tensor along the given dimension into chunks.

§Arguments
  • tensor - The tensor.
  • chunks - The number of chunks to be produced
  • times - The dimension along which the tensor will be split.
§Returns

A vector of tensors

source

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

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, 1>

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<const D: usize>(tensor: IntTensor<B, D>) -> BoolTensor<B, 1>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> BoolTensor<B, D>

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<const D: usize>(tensor: IntTensor<B, D>) -> BoolTensor<B, 1>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, ) -> BoolTensor<B, D>

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<const D: usize>(tensor: IntTensor<B, D>) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, descending: bool, ) -> IntTensor<B, D>

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, descending: bool, ) -> (IntTensor<B, D>, IntTensor<B, D>)

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<const D: usize>( tensor: IntTensor<B, D>, dim: usize, descending: bool, ) -> IntTensor<B, D>

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.

Object Safety§

This trait is not object safe.

Implementors§