Struct Float 

pub struct Float;

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

Trait Implementations

impl<B: AutodiffBackend> BasicAutodiffOps<B> for Float

type InnerKind = Float

Inner primitive tensor.

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

Returns the inner tensor without the autodiff information.

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

Convert a tensor to the autodiff backend.

impl<B: Backend> BasicOps<B> for Float

type Elem = <B as Backend>::FloatElem

The type of the tensor elements.

fn empty(shape: Shape, device: &B::Device, dtype: DType) -> Self::Primitive

Creates an empty tensor with the given shape.

fn full<E: ElementConversion>( shape: Shape, fill_value: E, device: &B::Device, dtype: DType, ) -> Self::Primitive

Creates a tensor of the given shape where each element is equal to the provided value.

fn register_transaction(tr: &mut Transaction<B>, tensor: Self::Primitive)

Read the data from the tensor using a transaction.

fn reshape(tensor: Self::Primitive, shape: Shape) -> Self::Primitive

Reshapes the tensor.

fn transpose(tensor: Self::Primitive) -> Self::Primitive

Transposes a tensor.

fn swap_dims( tensor: Self::Primitive, dim1: usize, dim2: usize, ) -> Self::Primitive

Swaps two dimensions of a tensor.

fn slice(tensor: Self::Primitive, slices: &[Slice]) -> Self::Primitive

Select tensor elements corresponding to the given slices.

fn slice_assign( tensor: Self::Primitive, slices: &[Slice], value: Self::Primitive, ) -> Self::Primitive

Assigns the given value to the tensor elements corresponding to the given slices.

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

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

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

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

fn device(tensor: &Self::Primitive) -> Device<B>

Returns the device on which the tensor is allocated.

fn to_device(tensor: Self::Primitive, device: &Device<B>) -> Self::Primitive

Moves the tensor to the given device.

async fn into_data_async(tensor: Self::Primitive) -> TensorData

Extracts the data from the tensor asynchronously.

fn from_data(data: TensorData, device: &B::Device) -> Self::Primitive

Creates a tensor from the given data.

fn from_data_dtype( data: TensorData, device: &B::Device, dtype: DType, ) -> Self::Primitive

Creates a tensor from the given data enforcing the given data type.

fn repeat_dim( tensor: Self::Primitive, dim: usize, times: usize, ) -> Self::Primitive

Repeat the tensor along the given dimension.

fn cat(vectors: Vec<Self::Primitive>, dim: usize) -> Self::Primitive

Concatenates the given tensors along the given dimension.

fn equal(lhs: Self::Primitive, rhs: Self::Primitive) -> B::BoolTensorPrimitive

Equates the given tensors.

fn not_equal( lhs: Self::Primitive, rhs: Self::Primitive, ) -> B::BoolTensorPrimitive

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

fn any(tensor: Self::Primitive) -> B::BoolTensorPrimitive

Tests if any element in the tensor evaluates to True.

fn any_dim(tensor: Self::Primitive, dim: usize) -> B::BoolTensorPrimitive

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

fn all(tensor: Self::Primitive) -> B::BoolTensorPrimitive

Tests if all elements in the tensor evaluate to True.

fn all_dim(tensor: Self::Primitive, dim: usize) -> B::BoolTensorPrimitive

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

fn permute(tensor: Self::Primitive, axes: &[usize]) -> Self::Primitive

Permutes the dimensions of a tensor.

fn expand(tensor: Self::Primitive, shape: Shape) -> Self::Primitive

Broadcasts the given tensor to the specified shape.

fn flip(tensor: Self::Primitive, axes: &[usize]) -> Self::Primitive

Flips the tensor along the given axes.

fn unfold( tensor: Self::Primitive, dim: usize, size: usize, step: usize, ) -> Self::Primitive

Unfold windows along a dimension.

fn slice_fill( tensor: Self::Primitive, slices: &[Slice], value: Self::Elem, ) -> Self::Primitive

Fills the tensor elements corresponding to the given slices with the given value.

fn slice_dim( tensor: Self::Primitive, dim: usize, slice: &Slice, ) -> Self::Primitive

Slices the tensor along a given dimension.

fn elem_type_name() -> &'static str

Returns the name of the element type.

fn dtype(tensor: &Self::Primitive) -> DType

Returns the tensor data type.

impl Clone for Float

fn clone(&self) -> Float

Returns a duplicate 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

Formats the value using the given formatter.

impl<B: Backend> Numeric<B> for Float

fn matmul(lhs: Self::Primitive, rhs: Self::Primitive) -> Self::Primitive

Applies the matrix multiplication operation.

C = AB

Panics

If the two tensors don’t have a compatible shape.

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

Adds two tensors together.

fn add_scalar<E: ElementConversion>( lhs: Self::Primitive, rhs: E, ) -> Self::Primitive

Adds a scalar to a tensor element-wise.

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

Subtracts two tensors.

fn sub_scalar<E: ElementConversion>( lhs: Self::Primitive, rhs: E, ) -> Self::Primitive

Subtracts a scalar from a tensor element-wise.

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

Divides two tensors.

fn div_scalar<E: ElementConversion>( lhs: Self::Primitive, rhs: E, ) -> Self::Primitive

Divides a tensor by a scalar element-wise.

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

Computes the modulo element-wise. The result is the signed remainder of the division and its absolute value is less than that of the divisor.

fn remainder_scalar<E: ElementConversion>( lhs: Self::Primitive, rhs: E, ) -> Self::Primitive

Computes the modulo element-wise. The result is the signed remainder of the division and its absolute value is less than that of the divisor.

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

Multiplies two tensors.

fn mul_scalar<E: ElementConversion>( lhs: Self::Primitive, rhs: E, ) -> Self::Primitive

Multiplies a tensor by a scalar element-wise.

fn neg(tensor: Self::Primitive) -> Self::Primitive

Negates a tensor.

fn zeros(shape: Shape, device: &B::Device, dtype: DType) -> Self::Primitive

Creates a tensor filled with zeros.

fn ones(shape: Shape, device: &B::Device, dtype: DType) -> Self::Primitive

Creates a tensor filled with ones.

fn sum(tensor: Self::Primitive) -> Self::Primitive

Sums all the elements of the tensor.

fn sum_dim(tensor: Self::Primitive, dim: usize) -> Self::Primitive

Sums all the elements of the tensor along a dimension.

fn prod(tensor: Self::Primitive) -> Self::Primitive

Computes the product of all the elements of the tensor.

fn prod_dim(tensor: Self::Primitive, dim: usize) -> Self::Primitive

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

fn mean(tensor: Self::Primitive) -> Self::Primitive

Computes the mean of all the elements of the tensor.

fn mean_dim(tensor: Self::Primitive, dim: usize) -> Self::Primitive

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

fn cumsum(tensor: Self::Primitive, dim: usize) -> Self::Primitive

Computes the cumulative sum of elements along a dimension.

fn cumprod(tensor: Self::Primitive, dim: usize) -> Self::Primitive

Computes the cumulative product of elements along a dimension.

fn cummin(tensor: Self::Primitive, dim: usize) -> Self::Primitive

Computes the cumulative minimum of elements along a dimension.

fn cummax(tensor: Self::Primitive, dim: usize) -> Self::Primitive

Computes the cumulative maximum of elements along a dimension.

fn equal_elem(lhs: Self::Primitive, rhs: Self::Elem) -> B::BoolTensorPrimitive

Element-wise equality between two tensors.

fn not_equal_elem( lhs: Self::Primitive, rhs: Self::Elem, ) -> B::BoolTensorPrimitive

Element-wise non-equality between two tensors.

fn greater(lhs: Self::Primitive, rhs: Self::Primitive) -> B::BoolTensorPrimitive

Element-wise greater than comparison between two tensors.

fn greater_elem(lhs: Self::Primitive, rhs: Self::Elem) -> B::BoolTensorPrimitive

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

fn greater_equal( lhs: Self::Primitive, rhs: Self::Primitive, ) -> B::BoolTensorPrimitive

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

fn greater_equal_elem( lhs: Self::Primitive, rhs: Self::Elem, ) -> B::BoolTensorPrimitive

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

fn lower(lhs: Self::Primitive, rhs: Self::Primitive) -> B::BoolTensorPrimitive

Element-wise less than comparison between two tensors.

fn lower_elem(lhs: Self::Primitive, rhs: Self::Elem) -> B::BoolTensorPrimitive

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

fn lower_equal( lhs: Self::Primitive, rhs: Self::Primitive, ) -> B::BoolTensorPrimitive

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

fn lower_equal_elem( lhs: Self::Primitive, rhs: Self::Elem, ) -> B::BoolTensorPrimitive

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

fn mask_where( tensor: Self::Primitive, mask: B::BoolTensorPrimitive, source: Self::Primitive, ) -> Self::Primitive

Selects elements from a tensor based on a boolean mask.

fn mask_fill( tensor: Self::Primitive, mask: B::BoolTensorPrimitive, value: Self::Elem, ) -> Self::Primitive

Fills elements of a tensor based on a boolean mask.

fn gather( dim: usize, tensor: Self::Primitive, indices: B::IntTensorPrimitive, ) -> Self::Primitive

Gathers elements from a tensor along an axis.

fn scatter( dim: usize, tensor: Self::Primitive, indices: B::IntTensorPrimitive, values: Self::Primitive, ) -> Self::Primitive

Scatters elements into a tensor along an axis.

fn argmax(tensor: Self::Primitive, dim: usize) -> IntTensor<B>

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

fn argmin(tensor: Self::Primitive, dim: usize) -> IntTensor<B>

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

fn max(tensor: Self::Primitive) -> Self::Primitive

Gets the maximum elements of a tensor along an axis.

fn max_dim(tensor: Self::Primitive, dim: usize) -> Self::Primitive

Gets the maximum elements of a tensor along an axis.

fn max_dim_with_indices( tensor: Self::Primitive, dim: usize, ) -> (Self::Primitive, IntTensor<B>)

Gets the maximum elements of a tensor along an axis.

fn min(tensor: Self::Primitive) -> Self::Primitive

Gets the minimum elements of a tensor along an axis.

fn min_dim(tensor: Self::Primitive, dim: usize) -> Self::Primitive

Gets the minimum elements of a tensor along an axis.

fn min_dim_with_indices( tensor: Self::Primitive, dim: usize, ) -> (Self::Primitive, IntTensor<B>)

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

fn clamp( tensor: Self::Primitive, min: B::FloatElem, max: B::FloatElem, ) -> Self::Primitive

Clamp the tensor between the given min and max values.

fn clamp_min(tensor: Self::Primitive, min: B::FloatElem) -> Self::Primitive

Clamps a tensor under a minimum value.

fn clamp_max(tensor: Self::Primitive, max: B::FloatElem) -> Self::Primitive

Clamps a tensor over a maximum value.

fn abs(tensor: Self::Primitive) -> Self::Primitive

Calculate absolute value on all elements of a tensor

fn powf(lhs: Self::Primitive, rhs: Self::Primitive) -> Self::Primitive

Element-wise power of a tensor to a float tensor

fn powf_scalar<E: ElementConversion>( lhs: Self::Primitive, rhs: E, ) -> Self::Primitive

Element-wise power of a tensor to a scalar float

fn powi(lhs: Self::Primitive, rhs: Self::Primitive) -> Self::Primitive

Element-wise power of a tensor

fn powi_scalar<E: ElementConversion>( lhs: Self::Primitive, rhs: E, ) -> Self::Primitive

Element-wise power of a tensor to a scalar int

fn random( shape: Shape, distribution: Distribution, device: &Device<B>, ) -> Self::Primitive

Create a random tensor.

fn sign(tensor: Self::Primitive) -> Self::Primitive

Returns the signs of the elements of a tensor.

fn sort( tensor: Self::Primitive, dim: usize, descending: bool, ) -> Self::Primitive

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

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

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

fn argsort( tensor: Self::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.

fn max_abs(tensor: Self::Primitive) -> Self::Primitive

Gets the maximum elements of a tensor along an axis.

fn max_abs_dim(tensor: Self::Primitive, dim: usize) -> Self::Primitive

Gets the maximum elements of a tensor along an axis.

impl<B: Backend> TensorKind<B> for Float

type Primitive = TensorPrimitive<B>

The primitive type of the tensor.

fn name() -> &'static str

The name of the tensor kind.