burn_tensor::ops

Trait FloatTensorOps

Source 
pub trait FloatTensorOps<B: Backend> {

Show 100 methods    // Required methods
    fn float_from_data(data: TensorData, device: &Device<B>) -> FloatTensor<B>;
    fn float_random(
        shape: Shape,
        distribution: Distribution,
        device: &Device<B>,
    ) -> FloatTensor<B>;
    fn float_into_data(
        tensor: FloatTensor<B>,
    ) -> impl Future<Output = TensorData> + 'static + Send;
    fn float_device(tensor: &FloatTensor<B>) -> Device<B>;
    fn float_to_device(
        tensor: FloatTensor<B>,
        device: &Device<B>,
    ) -> FloatTensor<B>;
    fn float_into_int(tensor: FloatTensor<B>) -> IntTensor<B>;
    fn float_empty(shape: Shape, device: &Device<B>) -> FloatTensor<B>;
    fn float_add(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> FloatTensor<B>;
    fn float_add_scalar(
        lhs: FloatTensor<B>,
        rhs: FloatElem<B>,
    ) -> FloatTensor<B>;
    fn float_sub(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> FloatTensor<B>;
    fn float_sub_scalar(
        lhs: FloatTensor<B>,
        rhs: FloatElem<B>,
    ) -> FloatTensor<B>;
    fn float_mul(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> FloatTensor<B>;
    fn float_mul_scalar(
        lhs: FloatTensor<B>,
        rhs: FloatElem<B>,
    ) -> FloatTensor<B>;
    fn float_div(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> FloatTensor<B>;
    fn float_div_scalar(
        lhs: FloatTensor<B>,
        rhs: FloatElem<B>,
    ) -> FloatTensor<B>;
    fn float_remainder(
        lhs: FloatTensor<B>,
        rhs: FloatTensor<B>,
    ) -> FloatTensor<B>;
    fn float_remainder_scalar(
        lhs: FloatTensor<B>,
        rhs: FloatElem<B>,
    ) -> FloatTensor<B>;
    fn float_matmul(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> FloatTensor<B>;
    fn float_recip(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_swap_dims(
        tensor: FloatTensor<B>,
        dim1: usize,
        dim2: usize,
    ) -> FloatTensor<B>;
    fn float_permute(tensor: FloatTensor<B>, axes: &[usize]) -> FloatTensor<B>;
    fn float_flip(tensor: FloatTensor<B>, axes: &[usize]) -> FloatTensor<B>;
    fn float_reshape(tensor: FloatTensor<B>, shape: Shape) -> FloatTensor<B>;
    fn float_gather(
        dim: usize,
        tensor: FloatTensor<B>,
        indices: IntTensor<B>,
    ) -> FloatTensor<B>;
    fn float_scatter(
        dim: usize,
        tensor: FloatTensor<B>,
        indices: IntTensor<B>,
        value: FloatTensor<B>,
    ) -> FloatTensor<B>;
    fn float_select(
        tensor: FloatTensor<B>,
        dim: usize,
        indices: IntTensor<B>,
    ) -> FloatTensor<B>;
    fn float_select_assign(
        tensor: FloatTensor<B>,
        dim: usize,
        indices: IntTensor<B>,
        value: FloatTensor<B>,
    ) -> FloatTensor<B>;
    fn float_slice(
        tensor: FloatTensor<B>,
        ranges: &[Range<usize>],
    ) -> FloatTensor<B>;
    fn float_slice_assign(
        tensor: FloatTensor<B>,
        ranges: &[Range<usize>],
        value: FloatTensor<B>,
    ) -> FloatTensor<B>;
    fn float_mask_where(
        tensor: FloatTensor<B>,
        mask: BoolTensor<B>,
        value: FloatTensor<B>,
    ) -> FloatTensor<B>;
    fn float_mask_fill(
        tensor: FloatTensor<B>,
        mask: BoolTensor<B>,
        value: FloatElem<B>,
    ) -> FloatTensor<B>;
    fn float_equal(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> BoolTensor<B>;
    fn float_equal_elem(lhs: FloatTensor<B>, rhs: FloatElem<B>) -> BoolTensor<B>;
    fn float_greater(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> BoolTensor<B>;
    fn float_greater_elem(
        lhs: FloatTensor<B>,
        rhs: FloatElem<B>,
    ) -> BoolTensor<B>;
    fn float_greater_equal(
        lhs: FloatTensor<B>,
        rhs: FloatTensor<B>,
    ) -> BoolTensor<B>;
    fn float_greater_equal_elem(
        lhs: FloatTensor<B>,
        rhs: FloatElem<B>,
    ) -> BoolTensor<B>;
    fn float_lower(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> BoolTensor<B>;
    fn float_lower_elem(lhs: FloatTensor<B>, rhs: FloatElem<B>) -> BoolTensor<B>;
    fn float_lower_equal(
        lhs: FloatTensor<B>,
        rhs: FloatTensor<B>,
    ) -> BoolTensor<B>;
    fn float_lower_equal_elem(
        lhs: FloatTensor<B>,
        rhs: FloatElem<B>,
    ) -> BoolTensor<B>;
    fn float_sum(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_sum_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B>;
    fn float_mean_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B>;
    fn float_cast(tensor: FloatTensor<B>, dtype: FloatDType) -> FloatTensor<B>;
    fn float_exp(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_log(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_log1p(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_powf(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> FloatTensor<B>;
    fn float_powf_scalar(tensor: FloatTensor<B>, value: f32) -> FloatTensor<B>;
    fn float_sqrt(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_abs(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_cos(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_sin(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_tanh(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_round(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_floor(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_ceil(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_erf(tensor: FloatTensor<B>) -> FloatTensor<B>;
    fn float_argmax(tensor: FloatTensor<B>, dim: usize) -> IntTensor<B>;
    fn float_argmin(tensor: FloatTensor<B>, dim: usize) -> IntTensor<B>;
    fn float_expand(tensor: FloatTensor<B>, shape: Shape) -> FloatTensor<B>;

    // Provided methods
    fn float_zeros(shape: Shape, device: &Device<B>) -> FloatTensor<B> { ... }
    fn float_ones(shape: Shape, device: &Device<B>) -> FloatTensor<B> { ... }
    fn float_full(
        shape: Shape,
        fill_value: FloatElem<B>,
        device: &Device<B>,
    ) -> FloatTensor<B> { ... }
    fn float_repeat_dim(
        tensor: FloatTensor<B>,
        dim: usize,
        times: usize,
    ) -> FloatTensor<B> { ... }
    fn float_clamp_min(
        tensor: FloatTensor<B>,
        min: FloatElem<B>,
    ) -> FloatTensor<B> { ... }
    fn float_clamp_max(
        tensor: FloatTensor<B>,
        max: FloatElem<B>,
    ) -> FloatTensor<B> { ... }
    fn float_clamp(
        tensor: FloatTensor<B>,
        min: FloatElem<B>,
        max: FloatElem<B>,
    ) -> FloatTensor<B> { ... }
    fn float_neg(tensor: FloatTensor<B>) -> FloatTensor<B> { ... }
    fn float_transpose(tensor: FloatTensor<B>) -> FloatTensor<B> { ... }
    fn float_not_equal(
        lhs: FloatTensor<B>,
        rhs: FloatTensor<B>,
    ) -> BoolTensor<B> { ... }
    fn float_not_equal_elem(
        lhs: FloatTensor<B>,
        rhs: FloatElem<B>,
    ) -> BoolTensor<B> { ... }
    fn float_detach(tensor: FloatTensor<B>) -> FloatTensor<B> { ... }
    fn float_set_require_grad(
        tensor: FloatTensor<B>,
        _require_grad: bool,
    ) -> FloatTensor<B> { ... }
    fn float_is_require_grad(_tensor: &FloatTensor<B>) -> bool { ... }
    fn float_prod(tensor: FloatTensor<B>) -> FloatTensor<B> { ... }
    fn float_prod_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B> { ... }
    fn float_mean(tensor: FloatTensor<B>) -> FloatTensor<B> { ... }
    fn float_powi(lhs: FloatTensor<B>, rhs: IntTensor<B>) -> FloatTensor<B> { ... }
    fn float_powi_scalar(lhs: FloatTensor<B>, rhs: IntElem<B>) -> FloatTensor<B> { ... }
    fn float_cat(tensors: Vec<FloatTensor<B>>, dim: usize) -> FloatTensor<B> { ... }
    fn float_max(tensor: FloatTensor<B>) -> FloatTensor<B> { ... }
    fn float_max_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B> { ... }
    fn float_max_dim_with_indices(
        tensor: FloatTensor<B>,
        dim: usize,
    ) -> (FloatTensor<B>, IntTensor<B>) { ... }
    fn float_min(tensor: FloatTensor<B>) -> FloatTensor<B> { ... }
    fn float_min_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B> { ... }
    fn float_min_dim_with_indices(
        tensor: FloatTensor<B>,
        dim: usize,
    ) -> (FloatTensor<B>, IntTensor<B>) { ... }
    fn float_narrow(
        tensor: FloatTensor<B>,
        dim: usize,
        start: usize,
        length: usize,
    ) -> FloatTensor<B> { ... }
    fn float_chunk(
        tensor: FloatTensor<B>,
        chunks: usize,
        dim: usize,
    ) -> Vec<FloatTensor<B>> ⓘ { ... }
    fn float_split(
        tensor: FloatTensor<B>,
        split_size: usize,
        dim: usize,
    ) -> Vec<FloatTensor<B>> ⓘ { ... }
    fn float_split_with_sizes(
        tensor: FloatTensor<B>,
        split_sizes: Vec<usize>,
        dim: usize,
    ) -> Vec<FloatTensor<B>> ⓘ { ... }
    fn float_any(tensor: FloatTensor<B>) -> BoolTensor<B> { ... }
    fn float_any_dim(tensor: FloatTensor<B>, dim: usize) -> BoolTensor<B> { ... }
    fn float_all(tensor: FloatTensor<B>) -> BoolTensor<B> { ... }
    fn float_all_dim(tensor: FloatTensor<B>, dim: usize) -> BoolTensor<B> { ... }
    fn float_sign(tensor: FloatTensor<B>) -> FloatTensor<B> { ... }
    fn float_sort(
        tensor: FloatTensor<B>,
        dim: usize,
        descending: bool,
    ) -> FloatTensor<B> { ... }
    fn float_sort_with_indices(
        tensor: FloatTensor<B>,
        dim: usize,
        descending: bool,
    ) -> (FloatTensor<B>, IntTensor<B>) { ... }
    fn float_argsort(
        tensor: FloatTensor<B>,
        dim: usize,
        descending: bool,
    ) -> IntTensor<B> { ... }

}
Expand description

Operations on float tensors.

Required Methods§

Source

fn float_from_data(data: TensorData, device: &Device<B>) -> FloatTensor<B>

Creates a new tensor from the data structure.

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

The tensor with the given data.

Source

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

Creates a new 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 float_into_data( tensor: FloatTensor<B>, ) -> impl Future<Output = TensorData> + 'static + Send

Converts the tensor to a data structure.

§Arguments
  • tensor - The tensor.
§Returns

The data structure with the tensor’s data.

Source

fn float_device(tensor: &FloatTensor<B>) -> Device<B>

Gets the device of the tensor.

§Arguments
  • tensor - The tensor.
§Returns

The device of the tensor.

Source

fn float_to_device(tensor: FloatTensor<B>, device: &Device<B>) -> FloatTensor<B>

Moves the tensor to the given device.

§Arguments
  • tensor - The tensor.
  • device - The device to move the tensor to.
§Returns

The tensor on the given device.

Source

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

Converts float tensor to int tensor.

§Arguments
  • tensor - The tensor.
§Returns

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

Source

fn float_empty(shape: Shape, device: &Device<B>) -> FloatTensor<B>

Creates an empty tensor with the given shape.

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

The empty tensor with the given shape.

Source

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

Adds two tensors together.

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

The result of adding the two tensors together.

Source

fn float_add_scalar(lhs: FloatTensor<B>, rhs: FloatElem<B>) -> FloatTensor<B>

Adds a scalar to a tensor.

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

The result of adding the scalar to the tensor.

Source

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

Subtracts two tensors.

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

The result of subtracting the two tensors.

Source

fn float_sub_scalar(lhs: FloatTensor<B>, rhs: FloatElem<B>) -> FloatTensor<B>

Subtracts a scalar from a tensor.

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

The result of subtracting the scalar from the tensor.

Source

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

Multiplies two tensors together element-wise.

Source

fn float_mul_scalar(lhs: FloatTensor<B>, rhs: FloatElem<B>) -> FloatTensor<B>

Multiplies a tensor by a scalar.

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

The result of multiplying the tensor by the scalar.

Source

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

Divides two tensors element-wise.

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

The result of dividing the two tensors.

Source

fn float_div_scalar(lhs: FloatTensor<B>, rhs: FloatElem<B>) -> FloatTensor<B>

Divides a tensor by a scalar.

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

The result of dividing the tensor by the scalar.

Source

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

Computes the remainder of division between two tensors element-wise.

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

The element-wise remainder when dividing lhs by rhs.

Source

fn float_remainder_scalar( lhs: FloatTensor<B>, rhs: FloatElem<B>, ) -> FloatTensor<B>

Computes the modulus of a tensor given 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 float_matmul(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> FloatTensor<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 float_recip(tensor: FloatTensor<B>) -> FloatTensor<B>

Calculates the reciprocals element-wise

Source

fn float_swap_dims( tensor: FloatTensor<B>, dim1: usize, dim2: usize, ) -> FloatTensor<B>

Swaps two dimensions of a 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 float_permute(tensor: FloatTensor<B>, axes: &[usize]) -> FloatTensor<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 float_flip(tensor: FloatTensor<B>, axes: &[usize]) -> FloatTensor<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 float_reshape(tensor: FloatTensor<B>, shape: Shape) -> FloatTensor<B>

Reshapes a tensor.

§Arguments
  • tensor - The tensor to reshape.
  • shape - The new shape of the tensor.
§Returns

The tensor with the new shape.

Source

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

Gather elements from a tensor.

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

The gathered elements.

Source

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

Scatter elements into a tensor.

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

The tensor with the scattered elements.

Source

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

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

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

The selected elements.

Source

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

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

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

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

Source

fn float_slice( tensor: FloatTensor<B>, ranges: &[Range<usize>], ) -> FloatTensor<B>

Select tensor elements corresponding for the given ranges.

§Arguments
  • tensor - The tensor to select from.
  • ranges - The ranges to select.
§Returns

The selected elements in a new tensor.

Source

fn float_slice_assign( tensor: FloatTensor<B>, ranges: &[Range<usize>], value: FloatTensor<B>, ) -> FloatTensor<B>

Assign the selected elements corresponding for the given ranges to the given value.

§Arguments
  • tensor - The tensor to select from.
  • ranges - The ranges to select.
  • value - The value to assign.
§Returns

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

Source

fn float_mask_where( tensor: FloatTensor<B>, mask: BoolTensor<B>, value: FloatTensor<B>, ) -> FloatTensor<B>

Update the given tensor with the value tensor where the mask is true.

§Arguments
  • tensor - The tensor to select from.
  • mask - The boolean mask to select with.
  • value - The value to assign to the selected elements from the value tensor.
§Returns

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

Source

fn float_mask_fill( tensor: FloatTensor<B>, mask: BoolTensor<B>, value: FloatElem<B>, ) -> FloatTensor<B>

Update the given tensor with the value where the mask is true.

§Arguments
  • tensor - The tensor to select from.
  • mask - The boolean mask to select with.
  • value - The value to assign to the selected elements.
§Returns

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

Source

fn float_equal(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> BoolTensor<B>

Equal comparison of two tensors.

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

A boolean tensor with the result of the comparison.

Source

fn float_equal_elem(lhs: FloatTensor<B>, rhs: FloatElem<B>) -> BoolTensor<B>

Equal comparison of a tensor and a scalar.

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

A boolean tensor with the result of the comparison.

Source

fn float_greater(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> BoolTensor<B>

Greater than comparison of two tensors.

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

A boolean tensor with the result of the comparison.

Source

fn float_greater_elem(lhs: FloatTensor<B>, rhs: FloatElem<B>) -> BoolTensor<B>

Greater than comparison of a tensor and a scalar.

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

A boolean tensor with the result of the comparison.

Source

fn float_greater_equal( lhs: FloatTensor<B>, rhs: FloatTensor<B>, ) -> BoolTensor<B>

Greater than or equal comparison of two tensors.

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

A boolean tensor with the result of the comparison.

Source

fn float_greater_equal_elem( lhs: FloatTensor<B>, rhs: FloatElem<B>, ) -> BoolTensor<B>

Greater than or equal comparison of a tensor and a scalar.

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

A boolean tensor with the result of the comparison.

Source

fn float_lower(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> BoolTensor<B>

Less than comparison of two tensors.

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

A boolean tensor with the result of the comparison.

Source

fn float_lower_elem(lhs: FloatTensor<B>, rhs: FloatElem<B>) -> BoolTensor<B>

Less than comparison of a tensor and a scalar.

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

A boolean tensor with the result of the comparison.

Source

fn float_lower_equal(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> BoolTensor<B>

Less than or equal comparison of two tensors.

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

A boolean tensor with the result of the comparison.

Source

fn float_lower_equal_elem( lhs: FloatTensor<B>, rhs: FloatElem<B>, ) -> BoolTensor<B>

Less than or equal comparison of a tensor and a scalar.

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

A boolean tensor with the result of the comparison.

Source

fn float_sum(tensor: FloatTensor<B>) -> FloatTensor<B>

Sum of all elements in a tensor.

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

A scalar tensor with the sum of all elements in tensor.

Source

fn float_sum_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B>

Sum of all elements in a tensor along a dimension.

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

A tensor with the sum of all elements in tensor along dim.

Source

fn float_mean_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B>

Mean of all elements in a tensor along a dimension.

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

A tensor with the mean of all elements in tensor along dim.

Source

fn float_cast(tensor: FloatTensor<B>, dtype: FloatDType) -> FloatTensor<B>

Converts a tensor to another floating point 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 floating point data type.

Source

fn float_exp(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with exponential values.

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

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

Source

fn float_log(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with natural logarithm values.

§Arguments
  • tensor - The tensor to take the logarithm of.
§Returns

A tensor with the same shape as tensor with natural logarithm values.

Source

fn float_log1p(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with logarithm values of (1 + Xi).

§Arguments
  • tensor - The tensor to take the logarithm of.
§Returns

A tensor with the same shape as tensor with logarithm values of (1 + Xi).

Source

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

Element-wise power with a FloatTensor.

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

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

Source

fn float_powf_scalar(tensor: FloatTensor<B>, value: f32) -> FloatTensor<B>

Returns a new tensor with values raised to the power of float value.

§Arguments
  • tensor - The tensor to exponentiate.
  • value - The exponent.
§Returns

A tensor with the same shape as tensor with values raised to the power of value.

Source

fn float_sqrt(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with square root values.

§Arguments
  • tensor - The tensor to take the square root of.
§Returns

A tensor with the same shape as tensor with square root values.

Source

fn float_abs(tensor: FloatTensor<B>) -> FloatTensor<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 float_cos(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with cosine values.

§Arguments
  • tensor - The tensor to take the cosine of.
§Returns

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

Source

fn float_sin(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with sine values.

§Arguments
  • tensor - The tensor to take the sine of.
§Returns

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

Source

fn float_tanh(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with tangent values.

§Arguments
  • tensor - The tensor to take the tangent of.
§Returns

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

Source

fn float_round(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with rounded values.

This function should implement the round half to even strategy, with halfway cases rounded to the nearest even integer value.

§Arguments
  • tensor - The tensor to be rounded.
§Returns

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

Source

fn float_floor(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with floored values.

§Arguments
  • tensor - The tensor to be floored.
§Returns

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

Source

fn float_ceil(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with ceiled values.

§Arguments
  • tensor - The tensor to be ceiled.
§Returns

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

Source

fn float_erf(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns a new tensor with the error function values.

§Arguments
  • tensor - The tensor to take the error function of.
§Returns

A tensor with the same shape as tensor with error function values.

Source

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

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

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

A tensor with the indices of the maximum elements of tensor along dim.

Source

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

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

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

A tensor with the indices of the minimum elements of tensor along dim.

Source

fn float_expand(tensor: FloatTensor<B>, shape: Shape) -> FloatTensor<B>

Broadcasts the float tensor to the given shape.

Provided Methods§

Source

fn float_zeros(shape: Shape, device: &Device<B>) -> FloatTensor<B>

Creates a new tensor with zeros.

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

The tensor with the given shape and zeros.

Source

fn float_ones(shape: Shape, device: &Device<B>) -> FloatTensor<B>

Creates a new tensor with ones.

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

The tensor with the given shape and ones.

Source

fn float_full( shape: Shape, fill_value: FloatElem<B>, device: &Device<B>, ) -> FloatTensor<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.
§Returns

The tensor filled with given value

Source

fn float_repeat_dim( tensor: FloatTensor<B>, dim: usize, times: usize, ) -> FloatTensor<B>

Repeat the tensor along the given dimension.

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

The tensor with the given dimension repeated.

Source

fn float_clamp_min(tensor: FloatTensor<B>, min: FloatElem<B>) -> FloatTensor<B>

Clamps a tensor under a minimum value.

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

The clamped tensor.

Source

fn float_clamp_max(tensor: FloatTensor<B>, max: FloatElem<B>) -> FloatTensor<B>

Clamps a tensor over a maximum value.

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

The clamped tensor.

Source

fn float_clamp( tensor: FloatTensor<B>, min: FloatElem<B>, max: FloatElem<B>, ) -> FloatTensor<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 float_neg(tensor: FloatTensor<B>) -> FloatTensor<B>

Negates a tensor element-wise.

Source

fn float_transpose(tensor: FloatTensor<B>) -> FloatTensor<B>

Transposes a tensor.

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

The transposed tensor.

Source

fn float_not_equal(lhs: FloatTensor<B>, rhs: FloatTensor<B>) -> BoolTensor<B>

Element-wise non-equality comparison.

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

A boolean tensor with the result of the comparison.

Source

fn float_not_equal_elem(lhs: FloatTensor<B>, rhs: FloatElem<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

A boolean tensor with the result of the comparison.

Source

fn float_detach(tensor: FloatTensor<B>) -> FloatTensor<B>

Detaches a tensor from the computation graph.

Source

fn float_set_require_grad( tensor: FloatTensor<B>, _require_grad: bool, ) -> FloatTensor<B>

Sets the require_grad flag of a tensor.

Source

fn float_is_require_grad(_tensor: &FloatTensor<B>) -> bool

Returns the require_grad flag of a tensor.

Source

fn float_prod(tensor: FloatTensor<B>) -> FloatTensor<B>

Product of all elements in a tensor.

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

A scalar tensor with the product of all elements in tensor.

Source

fn float_prod_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B>

Product of all elements in a tensor along a dimension.

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

A tensor with the product of all elements in tensor along dim.

Source

fn float_mean(tensor: FloatTensor<B>) -> FloatTensor<B>

Mean of all elements in a tensor.

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

A scalar tensor with the mean of all elements in tensor.

Source

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

Element-wise power with an IntTensor.

§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 float_powi_scalar(lhs: FloatTensor<B>, rhs: IntElem<B>) -> FloatTensor<B>

raises a tensor to the power of an int 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 float_cat(tensors: Vec<FloatTensor<B>>, dim: usize) -> FloatTensor<B>

Concatenates tensors along a dimension.

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

A tensor with the concatenated tensors along dim.

Source

fn float_max(tensor: FloatTensor<B>) -> FloatTensor<B>

Gets the maximum element of a tensor.

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

A tensor with the maximum element of tensor.

Source

fn float_max_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B>

Gets the maximum elements of a tensor along an axis.

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

A tensor with the maximum elements of tensor along dim.

Source

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

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

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

A tuple with the maximum elements of tensor along dim and their indices.

Source

fn float_min(tensor: FloatTensor<B>) -> FloatTensor<B>

Gets the minimum element of a tensor.

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

A tensor with the minimum element of tensor.

Source

fn float_min_dim(tensor: FloatTensor<B>, dim: usize) -> FloatTensor<B>

Gets the minimum elements of a tensor along an axis.

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

A tensor with the minimum elements of tensor along dim.

Source

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

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

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

A tuple with the minimum elements of tensor along dim and their indices.

Source

fn float_narrow( tensor: FloatTensor<B>, dim: usize, start: usize, length: usize, ) -> FloatTensor<B>

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 float_chunk( tensor: FloatTensor<B>, chunks: usize, dim: usize, ) -> Vec<FloatTensor<B>> ⓘ

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 float_split( tensor: FloatTensor<B>, split_size: usize, dim: usize, ) -> Vec<FloatTensor<B>> ⓘ

Split the tensor along the given dimension into chunks of split_size.

§Arguments
  • tensor - The tensor.
  • split_size - The size of a single chunk.
  • times - The dimension along which the tensor will be split.
§Returns

A vector of tensors.

Source

fn float_split_with_sizes( tensor: FloatTensor<B>, split_sizes: Vec<usize>, dim: usize, ) -> Vec<FloatTensor<B>> ⓘ

Split the tensor along the given dimension into chunks with sizes in dim according to split_sizes.

§Arguments
  • tensor - The tensor.
  • split_sizes - Vector of sizes for each chunk.
  • times - The dimension along which the tensor will be split.
§Returns

A vector of tensors.

Source

fn float_any(tensor: FloatTensor<B>) -> BoolTensor<B>

Tests if any element in the float 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 float_any_dim(tensor: FloatTensor<B>, dim: usize) -> BoolTensor<B>

Tests if any element in the float 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 float_all(tensor: FloatTensor<B>) -> BoolTensor<B>

Tests if all elements in the float 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 float_all_dim(tensor: FloatTensor<B>, dim: usize) -> BoolTensor<B>

Tests if all elements in the float 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 float_sign(tensor: FloatTensor<B>) -> FloatTensor<B>

Returns the signs of the float 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 float_sort( tensor: FloatTensor<B>, dim: usize, descending: bool, ) -> FloatTensor<B>

Sort the elements of the input tensor by value in 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 float_sort_with_indices( tensor: FloatTensor<B>, dim: usize, descending: bool, ) -> (FloatTensor<B>, IntTensor<B>)

Sort the elements of the input tensor by value in 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 and corresponding indices, where the elements are sorted by value and the indices map back to the original input tensor.

Source

fn float_argsort( tensor: FloatTensor<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§