Struct burn::prelude::Int

pub struct Int;

A type-level representation of the kind of a int tensor.

Trait Implementations

impl<B> BasicAutodiffOps<B> for Int

where B: AutodiffBackend,

type InnerKind = Int

Inner primitive tensor.

fn inner( tensor: <Int as TensorKind<B>>::Primitive, ) -> <<Int as BasicAutodiffOps<B>>::InnerKind as TensorKind<<B as AutodiffBackend>::InnerBackend>>::Primitive

Returns the inner tensor without the autodiff information.

fn from_inner( inner: <<Int as BasicAutodiffOps<B>>::InnerKind as TensorKind<<B as AutodiffBackend>::InnerBackend>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Convert a tensor to the autodiff backend.

impl<B> BasicOps<B> for Int

where B: Backend,

type Elem = <B as Backend>::IntElem

The type of the tensor elements.

fn empty( shape: Shape, device: &<B as Backend>::Device, ) -> <Int as TensorKind<B>>::Primitive

Creates an empty tensor with the given shape.

fn shape(tensor: &<Int as TensorKind<B>>::Primitive) -> Shape

Returns the shape of the tensor.

fn reshape( tensor: <Int as TensorKind<B>>::Primitive, shape: Shape, ) -> <Int as TensorKind<B>>::Primitive

Reshapes the tensor.

fn transpose( tensor: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Transposes a tensor.

fn swap_dims( tensor: <Int as TensorKind<B>>::Primitive, dim1: usize, dim2: usize, ) -> <Int as TensorKind<B>>::Primitive

Swaps two dimensions of a tensor.

fn slice( tensor: <Int as TensorKind<B>>::Primitive, ranges: &[Range<usize>], ) -> <Int as TensorKind<B>>::Primitive

Select tensor elements corresponding for the given ranges.

fn slice_assign( tensor: <Int as TensorKind<B>>::Primitive, ranges: &[Range<usize>], value: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Assigns the given value to the tensor elements corresponding for the given ranges.

fn device(tensor: &<Int as TensorKind<B>>::Primitive) -> <B as Backend>::Device

Returns the device on which the tensor is allocated.

fn to_device( tensor: <Int as TensorKind<B>>::Primitive, device: &<B as Backend>::Device, ) -> <Int as TensorKind<B>>::Primitive

Moves the tensor to the given device.

async fn into_data_async( tensor: <Int as TensorKind<B>>::Primitive, ) -> TensorData

Extracts the data from the tensor asynchronously.

fn from_data( data: TensorData, device: &<B as Backend>::Device, ) -> <Int as TensorKind<B>>::Primitive

Creates a tensor from the given data.

fn repeat_dim( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, times: usize, ) -> <Int as TensorKind<B>>::Primitive

Repeat the tensor along the given dimension.

fn equal( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <B as Backend>::BoolTensorPrimitive

Equates the given tensors.

fn not_equal( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <B as Backend>::BoolTensorPrimitive

Applies element-wise non-equality comparison between the given tensors.

fn cat( vectors: Vec<<Int as TensorKind<B>>::Primitive>, dim: usize, ) -> <Int as TensorKind<B>>::Primitive

Concatenates the given tensors along the given dimension.

fn any( tensor: <Int as TensorKind<B>>::Primitive, ) -> <B as Backend>::BoolTensorPrimitive

Tests if any element in the tensor evaluates to True.

fn any_dim( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> <B as Backend>::BoolTensorPrimitive

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

fn all( tensor: <Int as TensorKind<B>>::Primitive, ) -> <B as Backend>::BoolTensorPrimitive

Tests if all elements in the tensor evaluate to True.

fn all_dim( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> <B as Backend>::BoolTensorPrimitive

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

fn permute( tensor: <Int as TensorKind<B>>::Primitive, axes: &[usize], ) -> <Int as TensorKind<B>>::Primitive

Permutes the dimensions of a tensor.

fn expand( tensor: <Int as TensorKind<B>>::Primitive, shape: Shape, ) -> <Int as TensorKind<B>>::Primitive

Broadcasts the given tensor to the specified shape.

fn flip( tensor: <Int as TensorKind<B>>::Primitive, axes: &[usize], ) -> <Int as TensorKind<B>>::Primitive

Flips the tensor along the given axes.

fn chunk( tensor: <Int as TensorKind<B>>::Primitive, chunks: usize, dim: usize, ) -> Vec<<Int as TensorKind<B>>::Primitive>

Attempts to split the tensor along the given dimension into chunks. May return less chunks than requested if the tensor size is not divisible by the number of chunks.

fn elem_type_name() -> &'static str

Returns the name of the element type.

impl Clone for Int

fn clone(&self) -> Int

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Int

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<B> Numeric<B> for Int

where B: Backend,

fn add( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Adds two tensors together.

fn add_scalar<E>( lhs: <Int as TensorKind<B>>::Primitive, rhs: E, ) -> <Int as TensorKind<B>>::Primitive

where E: ElementConversion,

Adds a scalar to a tensor element-wise.

fn sub( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Subtracts two tensors.

fn sub_scalar<E>( lhs: <Int as TensorKind<B>>::Primitive, rhs: E, ) -> <Int as TensorKind<B>>::Primitive

where E: ElementConversion,

Subtracts a scalar from a tensor element-wise.

fn div( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Divides two tensors.

fn div_scalar<E>( lhs: <Int as TensorKind<B>>::Primitive, rhs: E, ) -> <Int as TensorKind<B>>::Primitive

where E: ElementConversion,

Divides a tensor by a scalar element-wise.

fn remainder_scalar<E>( lhs: <Int as TensorKind<B>>::Primitive, rhs: E, ) -> <Int as TensorKind<B>>::Primitive

where E: ElementConversion,

Computes the modulus element-wise. The result has the same sign as the divisor rhs and its absolute value is less than that of the divisor.

fn mul( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Multiplies two tensors.

fn mul_scalar<E>( lhs: <Int as TensorKind<B>>::Primitive, rhs: E, ) -> <Int as TensorKind<B>>::Primitive

where E: ElementConversion,

Multiplies a tensor by a scalar element-wise.

fn neg( tensor: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Negates a tensor.

fn zeros( shape: Shape, device: &<B as Backend>::Device, ) -> <Int as TensorKind<B>>::Primitive

Creates a tensor filled with zeros.

fn ones( shape: Shape, device: &<B as Backend>::Device, ) -> <Int as TensorKind<B>>::Primitive

Creates a tensor filled with ones.

fn full<E>( shape: Shape, fill_value: E, device: &<B as Backend>::Device, ) -> <Int as TensorKind<B>>::Primitive

where E: ElementConversion,

Creates a tensor filled with elements equal to the given value.

fn sum( tensor: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Sums all the elements of the tensor.

fn sum_dim( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> <Int as TensorKind<B>>::Primitive

Sums all the elements of the tensor along a dimension.

fn prod( tensor: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Computes the product of all the elements of the tensor.

fn prod_dim( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> <Int as TensorKind<B>>::Primitive

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

fn mean( tensor: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Computes the mean of all the elements of the tensor.

fn mean_dim( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> <Int as TensorKind<B>>::Primitive

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

fn equal_elem( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as BasicOps<B>>::Elem, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise equality between two tensors.

fn not_equal_elem( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as BasicOps<B>>::Elem, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise non-equality between two tensors.

fn greater( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise greater than comparison between two tensors.

fn greater_elem( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as BasicOps<B>>::Elem, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise greater than comparison between a tensor and a scalar.

fn greater_equal( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise greater than or equal comparison between two tensors.

fn greater_equal_elem( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as BasicOps<B>>::Elem, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise greater than or equal comparison between a tensor and a scalar.

fn lower( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise less than comparison between two tensors.

fn lower_elem( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as BasicOps<B>>::Elem, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise less than comparison between a tensor and a scalar.

fn lower_equal( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise less than or equal comparison between two tensors.

fn lower_equal_elem( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as BasicOps<B>>::Elem, ) -> <B as Backend>::BoolTensorPrimitive

Element-wise less than or equal comparison between a tensor and a scalar.

fn mask_where( tensor: <Int as TensorKind<B>>::Primitive, mask: <B as Backend>::BoolTensorPrimitive, source: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Selects elements from a tensor based on a boolean mask.

fn mask_fill( tensor: <Int as TensorKind<B>>::Primitive, mask: <B as Backend>::BoolTensorPrimitive, value: <Int as BasicOps<B>>::Elem, ) -> <Int as TensorKind<B>>::Primitive

Fills elements of a tensor based on a boolean mask.

fn select( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, indices: Tensor<B, 1, Int>, ) -> <Int as TensorKind<B>>::Primitive

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

fn select_assign( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, indices: Tensor<B, 1, Int>, values: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

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

fn gather( dim: usize, tensor: <Int as TensorKind<B>>::Primitive, indices: <B as Backend>::IntTensorPrimitive, ) -> <Int as TensorKind<B>>::Primitive

Gathers elements from a tensor along an axis.

fn scatter( dim: usize, tensor: <Int as TensorKind<B>>::Primitive, indices: <B as Backend>::IntTensorPrimitive, values: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Scatters elements into a tensor along an axis.

fn argmax( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> <B as Backend>::IntTensorPrimitive

Gets the indices of the maximum elements of a tensor along an axis.

fn argmin( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> <B as Backend>::IntTensorPrimitive

Gets the indices of the minimum elements of a tensor along an axis.

fn max( tensor: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Gets the maximum elements of a tensor along an axis.

fn max_dim( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> <Int as TensorKind<B>>::Primitive

Gets the maximum elements of a tensor along an axis.

fn max_dim_with_indices( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> (<Int as TensorKind<B>>::Primitive, <B as Backend>::IntTensorPrimitive)

Gets the maximum elements of a tensor along an axis.

fn min( tensor: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Gets the minimum elements of a tensor along an axis.

fn min_dim( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> <Int as TensorKind<B>>::Primitive

Gets the minimum elements of a tensor along an axis.

fn min_dim_with_indices( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, ) -> (<Int as TensorKind<B>>::Primitive, <B as Backend>::IntTensorPrimitive)

Gets the minimum elements and indices of a tensor along an axis.

fn clamp( tensor: <Int as TensorKind<B>>::Primitive, min: <B as Backend>::IntElem, max: <B as Backend>::IntElem, ) -> <Int as TensorKind<B>>::Primitive

Clamp the tensor between the given min and max values.

fn clamp_min( tensor: <Int as TensorKind<B>>::Primitive, min: <B as Backend>::IntElem, ) -> <Int as TensorKind<B>>::Primitive

Clamps a tensor under a minimum value.

fn clamp_max( tensor: <Int as TensorKind<B>>::Primitive, max: <B as Backend>::IntElem, ) -> <Int as TensorKind<B>>::Primitive

Clamps a tensor over a maximum value.

fn abs( tensor: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Calculate absolute value on all elements of a tensor

fn powf( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Element-wise power of a tensor to a float tensor

fn powf_scalar<E>( lhs: <Int as TensorKind<B>>::Primitive, rhs: E, ) -> <Int as TensorKind<B>>::Primitive

where E: ElementConversion,

Element-wise power of a tensor to a scalar float

fn powi( lhs: <Int as TensorKind<B>>::Primitive, rhs: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Element-wise power of a tensor

fn powi_scalar<E>( lhs: <Int as TensorKind<B>>::Primitive, rhs: E, ) -> <Int as TensorKind<B>>::Primitive

where E: ElementConversion,

Element-wise power of a tensor to a scalar int

fn random( shape: Shape, distribution: Distribution, device: &<B as Backend>::Device, ) -> <Int as TensorKind<B>>::Primitive

Create a random tensor.

fn sign( tensor: <Int as TensorKind<B>>::Primitive, ) -> <Int as TensorKind<B>>::Primitive

Returns the signs of the elements of a tensor.

fn sort( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, descending: bool, ) -> <Int as TensorKind<B>>::Primitive

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

fn sort_with_indices( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, descending: bool, ) -> (<Int as TensorKind<B>>::Primitive, <Int as TensorKind<B>>::Primitive)

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

fn argsort( tensor: <Int as TensorKind<B>>::Primitive, dim: usize, descending: bool, ) -> <Int as TensorKind<B>>::Primitive

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

impl<B> TensorKind<B> for Int

where B: Backend,

type Primitive = <B as Backend>::IntTensorPrimitive

The primitive type of the tensor.

fn name() -> &'static str

The name of the tensor kind.