Struct TensorWrapper 

pub struct TensorWrapper<'a, B, const D: usize, K = Float>
where
    B: Backend,
    K: BasicOps<B>,
{ /* private fields */ }

👎Deprecated since 0.1.0: Use bimm-contracts instead

A wrapper around a Tensor that provides additional assertions.

Implementations

impl<B, const D: usize, K> TensorWrapper<'_, B, D, K>

where B: Backend, K: BasicOps<B>,

pub fn has_dims(&self, dims: [usize; D]) -> &Self

👎Deprecated since 0.1.0: Use bimm-contracts instead

Assert that the wrapped tensor has the expected dimensions.

Parameters

• dims: The expected dimensions of the tensor.

Panics

Panics if the tensor does not have the expected dimensions.

Example:

use burn::backend::NdArray;
use burn::tensor::Tensor;
use burn_contracts::assert_tensor;

let device = Default::default();
let tensor = Tensor::<NdArray, 2>::from_data([[2., 3.], [4., 5.]], &device);

assert_tensor(&tensor).has_dims([2, 2]);

pub fn unpacks_shape<const S: usize, C: ShapeBindingSource>( &self, keys: [&str; S], pattern: &str, bindings: C, ) -> Result<[usize; S], ShapePatternError>

👎Deprecated since 0.1.0: Use bimm-contracts instead

Unpacks components of the shape of the tensor according to a pattern.

Parameters

• keys: The keys to select from the unpacked shape.
• pattern: The pattern to unpack the shape.
• bindings: The bindings to use for the unpacking.

Returns

The unpacked shape.

Errors

Returns an error if the pattern is invalid or the bindings are not found, or do not match the shape.

Example

#[cfg(test)]
mod tests {
   use burn::backend::NdArray;
   use burn::tensor::Tensor;
   use burn_contracts::assert_tensor;

   #[test]
   fn example() -> Result<(), Box<dyn std::error::Error>> {
       let device = Default::default();
       let tensor = Tensor::<NdArray, 6>::zeros([2, 2, 2, 5 * 4, 4 * 4, 3], &device);

       let [b, h, w] = assert_tensor(&tensor).unpacks_shape(
          ["b", "h", "w"],
          "b ... (h p) (w p) c",
          &[("p", 4), ("c", 3)],
       )?;

       assert_eq!(b, 2);
       assert_eq!(h, 5);
       assert_eq!(w, 4);

       Ok(())
   }
}

pub fn has_named_dims(&self, dims: [(&str, usize); D]) -> &Self

👎Deprecated since 0.1.0: Use bimm-contracts instead

Assert that the wrapped tensor has the expected named dimensions.

Parameters

• dims: The expected named dimensions of the tensor.

Panics

Panics if the tensor does not have the expected named dimensions.

Example:

use burn::backend::NdArray;
use burn::tensor::Tensor;
use burn_contracts::assert_tensor;

let device = Default::default();
let tensor = Tensor::<NdArray, 2>::from_data([[2., 3.], [4., 5.]], &device);

assert_tensor(&tensor).has_named_dims([("rows", 2), ("cols", 2)]);

Trait Implementations

impl<'a, B, const D: usize, K> Clone for TensorWrapper<'a, B, D, K>

where B: Backend + Clone, K: BasicOps<B> + Clone,

fn clone(&self) -> TensorWrapper<'a, B, D, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, B, const D: usize, K> Debug for TensorWrapper<'a, B, D, K>

where B: Backend + Debug, K: BasicOps<B> + Debug,

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

Formats the value using the given formatter.