Trait Tensor

pub trait Tensor<S, D>
where
    S: RawData<Elem = Self::Scalar>,
    D: Dimension,
{
    type Scalar;
    type Container<U: RawData, V: Dimension>;

    // Required methods
    fn from_shape_with_fn<Sh, F>(shape: Sh, f: F) -> Self::Container<S, D>
       where Sh: ShapeBuilder<Dim = D>,
             F: FnMut(D::Pattern) -> Self::Scalar,
             Self: Sized;
    fn from_shape_with_value<Sh>(
        shape: Sh,
        value: Self::Scalar,
    ) -> Self::Container<S, D>
       where Sh: ShapeBuilder<Dim = D>,
             Self: Sized;
    fn data(&self) -> &Self::Container<S, D>;
    fn data_mut(&mut self) -> &mut Self::Container<S, D>;
    fn dim(&self) -> D::Pattern;
    fn raw_dim(&self) -> D;
    fn shape(&self) -> &[usize];
    fn apply<F, B>(&self, f: F) -> Self::Container<OwnedRepr<B>, D>
       where F: FnMut(Self::Scalar) -> B;
    fn apply_mut<F>(&mut self, f: F)
       where S: DataMut,
             F: FnMut(Self::Scalar) -> Self::Scalar;
    fn axis_iter(&self, axis: usize) -> AxisIter<'_, Self::Scalar, D::Smaller>
       where D: RemoveAxis;
    fn iter(&self) -> Iter<'_, Self::Scalar, D>;
    fn iter_mut(&mut self) -> IterMut<'_, Self::Scalar, D>
       where S: DataMut;

    // Provided methods
    fn default<Sh>(shape: Sh) -> Self::Container<S, D>
       where Sh: ShapeBuilder<Dim = D>,
             Self: Sized,
             Self::Scalar: Default { ... }
    fn ones<Sh>(shape: Sh) -> Self::Container<S, D>
       where Sh: ShapeBuilder<Dim = D>,
             Self: Sized,
             Self::Scalar: Clone + One { ... }
    fn zeros<Sh>(shape: Sh) -> Self::Container<S, D>
       where Sh: ShapeBuilder<Dim = D>,
             Self: Sized,
             Self::Scalar: Clone + Zero { ... }
    fn set_data(&mut self, data: Self::Container<S, D>) -> &mut Self { ... }
    fn mean(&self) -> Self::Scalar
       where Self::Scalar: Scalar { ... }
    fn sum(&self) -> Self::Scalar
       where Self::Scalar: Clone + Sum { ... }
    fn pow2(&self) -> Self::Container<OwnedRepr<Self::Scalar>, D>
       where Self::Scalar: Scalar { ... }
    fn abs(&self) -> Self::Container<OwnedRepr<Self::Scalar>, D>
       where Self::Scalar: Signed { ... }
    fn neg(&self) -> Self::Container<OwnedRepr<Self::Scalar>, D>
       where Self::Scalar: Neg<Output = Self::Scalar> { ... }
}

Required Associated Types

type Scalar

type Container<U: RawData, V: Dimension>

Required Methods

fn from_shape_with_fn<Sh, F>(shape: Sh, f: F) -> Self::Container<S, D>

where Sh: ShapeBuilder<Dim = D>, F: FnMut(D::Pattern) -> Self::Scalar, Self: Sized,

Create a new tensor with the given shape and a function to fill it

fn from_shape_with_value<Sh>( shape: Sh, value: Self::Scalar, ) -> Self::Container<S, D>

where Sh: ShapeBuilder<Dim = D>, Self: Sized,

Create a new tensor with the given shape and value

fn data(&self) -> &Self::Container<S, D>

returns a reference to the data of the object

fn data_mut(&mut self) -> &mut Self::Container<S, D>

returns a mutable reference to the data of the object

fn dim(&self) -> D::Pattern

returns the number of dimensions of the object

fn raw_dim(&self) -> D

returns the shape of the object

fn shape(&self) -> &[usize]

returns the shape of the object

fn apply<F, B>(&self, f: F) -> Self::Container<OwnedRepr<B>, D>

where F: FnMut(Self::Scalar) -> B,

returns a new tensor with the same shape as the object and the given function applied to each element

fn apply_mut<F>(&mut self, f: F)

where S: DataMut, F: FnMut(Self::Scalar) -> Self::Scalar,

returns a new tensor with the same shape as the object and the given function applied

fn axis_iter(&self, axis: usize) -> AxisIter<'_, Self::Scalar, D::Smaller>

where D: RemoveAxis,

fn iter(&self) -> Iter<'_, Self::Scalar, D>

fn iter_mut(&mut self) -> IterMut<'_, Self::Scalar, D>

where S: DataMut,

Provided Methods

fn default<Sh>(shape: Sh) -> Self::Container<S, D>

where Sh: ShapeBuilder<Dim = D>, Self: Sized, Self::Scalar: Default,

Create a new tensor with the given shape and all values set to their default

fn ones<Sh>(shape: Sh) -> Self::Container<S, D>

where Sh: ShapeBuilder<Dim = D>, Self: Sized, Self::Scalar: Clone + One,

create a new tensor with the given shape and all values set to one

fn zeros<Sh>(shape: Sh) -> Self::Container<S, D>

where Sh: ShapeBuilder<Dim = D>, Self: Sized, Self::Scalar: Clone + Zero,

create a new tensor with the given shape and all values set to zero

fn set_data(&mut self, data: Self::Container<S, D>) -> &mut Self

sets the data of the object

fn mean(&self) -> Self::Scalar

where Self::Scalar: Scalar,

fn sum(&self) -> Self::Scalar

where Self::Scalar: Clone + Sum,

fn pow2(&self) -> Self::Container<OwnedRepr<Self::Scalar>, D>

where Self::Scalar: Scalar,

fn abs(&self) -> Self::Container<OwnedRepr<Self::Scalar>, D>

where Self::Scalar: Signed,

fn neg(&self) -> Self::Container<OwnedRepr<Self::Scalar>, D>

where Self::Scalar: Neg<Output = Self::Scalar>,

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.

Implementations on Foreign Types

impl<A, S, D> Tensor<S, D> for ArrayBase<S, D>

where S: DataOwned<Elem = A>, A: Scalar, D: Dimension,

type Scalar = A

type Container<U: RawData, V: Dimension> = ArrayBase<U, V>

fn from_shape_with_value<Sh>( shape: Sh, value: Self::Scalar, ) -> Self::Container<S, D>

where Self: Sized, Sh: ShapeBuilder<Dim = D>,

fn from_shape_with_fn<Sh, F>(shape: Sh, f: F) -> Self::Container<S, D>

where Self: Sized, Sh: ShapeBuilder<Dim = D>, F: FnMut(D::Pattern) -> Self::Scalar,

fn data(&self) -> &Self::Container<S, D>

fn data_mut(&mut self) -> &mut Self::Container<S, D>

fn dim(&self) -> D::Pattern

fn raw_dim(&self) -> D

fn shape(&self) -> &[usize]

fn apply<F, B>(&self, f: F) -> Self::Container<OwnedRepr<B>, D>

where F: FnMut(Self::Scalar) -> B,

fn apply_mut<F>(&mut self, f: F)

where F: FnMut(Self::Scalar) -> Self::Scalar, S: DataMut,

fn iter(&self) -> Iter<'_, Self::Scalar, D>

fn iter_mut(&mut self) -> IterMut<'_, Self::Scalar, D>

where S: DataMut,

fn axis_iter(&self, axis: usize) -> AxisIter<'_, Self::Scalar, D::Smaller>

where D: RemoveAxis,

Implementors