Struct burn::tensor::Float

pub struct Float;

A type-level representation of the kind of a float tensor

Trait Implementations

impl<B> BasicAutodiffOps<B> for Float

where B: AutodiffBackend,

type InnerKind = Float

Inner primitive tensor.

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

Returns the inner tensor without the autodiff information.

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

Convert a tensor to the autodiff backend.

impl<B> BasicOps<B> for Float

where B: Backend,

type Elem = <B as Backend>::FloatElem

The type of the tensor elements.

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

Creates an empty tensor with the given shape.

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

Returns the shape of the tensor.

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

Reshapes the tensor.

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

Transposes a tensor.

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

Swaps two dimensions of a tensor.

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

Select tensor elements corresponding for the given ranges.

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

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

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

Returns the device on which the tensor is allocated.

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

Moves the tensor to the given device.

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

Extracts the data from the tensor asynchronously.

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

Creates a tensor from the given data.

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

Repeat the tensor along the given dimension.

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

Concatenates the given tensors along the given dimension.

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

Equates the given tensors.

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

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

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

Tests if any element in the tensor evaluates to True.

fn any_dim( tensor: <Float 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: <Float as TensorKind<B>>::Primitive, ) -> <B as Backend>::BoolTensorPrimitive

Tests if all elements in the tensor evaluate to True.

fn all_dim( tensor: <Float 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: <Float as TensorKind<B>>::Primitive, axes: &[usize], ) -> <Float as TensorKind<B>>::Primitive

Permutes the dimensions of a tensor.

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

Broadcasts the given tensor to the specified shape.

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

Flips the tensor along the given axes.

fn chunk( tensor: <Float as TensorKind<B>>::Primitive, chunks: usize, dim: usize, ) -> Vec<<Float 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 Float

fn clone(&self) -> Float

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Float

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

Formats the value using the given formatter.

impl<B> Numeric<B> for Float

where B: Backend,

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

Adds two tensors together.

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

where E: ElementConversion,

Adds a scalar to a tensor element-wise.

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

Subtracts two tensors.

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

where E: ElementConversion,

Subtracts a scalar from a tensor element-wise.

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

Divides two tensors.

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

where E: ElementConversion,

Divides a tensor by a scalar element-wise.

fn remainder_scalar<E>( lhs: <Float as TensorKind<B>>::Primitive, rhs: E, ) -> <Float 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: <Float as TensorKind<B>>::Primitive, rhs: <Float as TensorKind<B>>::Primitive, ) -> <Float as TensorKind<B>>::Primitive

Multiplies two tensors.

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

where E: ElementConversion,

Multiplies a tensor by a scalar element-wise.

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

Negates a tensor.

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

Creates a tensor filled with zeros.

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

Creates a tensor filled with ones.

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

where E: ElementConversion,

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

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

Sums all the elements of the tensor.

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

Sums all the elements of the tensor along a dimension.

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

Computes the product of all the elements of the tensor.

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

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

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

Computes the mean of all the elements of the tensor.

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

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

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

Element-wise equality between two tensors.

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

Element-wise non-equality between two tensors.

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

Element-wise greater than comparison between two tensors.

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

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

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

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

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

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

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

Element-wise less than comparison between two tensors.

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

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

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

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

fn lower_equal_elem( lhs: <Float as TensorKind<B>>::Primitive, rhs: <Float 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: <Float as TensorKind<B>>::Primitive, mask: <B as Backend>::BoolTensorPrimitive, source: <Float as TensorKind<B>>::Primitive, ) -> <Float as TensorKind<B>>::Primitive

Selects elements from a tensor based on a boolean mask.

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

Fills elements of a tensor based on a boolean mask.

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

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

fn select_assign( tensor: <Float as TensorKind<B>>::Primitive, dim: usize, indices: Tensor<B, 1, Int>, values: <Float as TensorKind<B>>::Primitive, ) -> <Float 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: <Float as TensorKind<B>>::Primitive, indices: <B as Backend>::IntTensorPrimitive, ) -> <Float as TensorKind<B>>::Primitive

Gathers elements from a tensor along an axis.

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

Scatters elements into a tensor along an axis.

fn argmax( tensor: <Float 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: <Float 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: <Float as TensorKind<B>>::Primitive, ) -> <Float as TensorKind<B>>::Primitive

Gets the maximum elements of a tensor along an axis.

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

Gets the maximum elements of a tensor along an axis.

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

Gets the maximum elements of a tensor along an axis.

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

Gets the minimum elements of a tensor along an axis.

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

Gets the minimum elements of a tensor along an axis.

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

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

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

Clamp the tensor between the given min and max values.

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

Clamps a tensor under a minimum value.

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

Clamps a tensor over a maximum value.

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

Calculate absolute value on all elements of a tensor

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

Element-wise power of a tensor to a float tensor

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

where E: ElementConversion,

Element-wise power of a tensor to a scalar float

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

Element-wise power of a tensor

fn powi_scalar<E>( lhs: <Float as TensorKind<B>>::Primitive, rhs: E, ) -> <Float 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, ) -> <Float as TensorKind<B>>::Primitive

Create a random tensor.

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

Returns the signs of the elements of a tensor.

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

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

fn sort_with_indices( tensor: <Float as TensorKind<B>>::Primitive, dim: usize, descending: bool, ) -> (<Float 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: <Float 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 Float

where B: Backend,

type Primitive = TensorPrimitive<B>

The primitive type of the tensor.

fn name() -> &'static str

The name of the tensor kind.