Struct Tensor 

pub struct Tensor<T, A: Backend = CpuBackend> {
    pub storage: Buffer<T, A>,
    pub dimensions: Dimensions,
}

Fields

storage: Buffer<T, A>

dimensions: Dimensions

Implementations

impl<T, A: Backend> Tensor<T, A>

pub fn with_sizes_in(sizes: impl AsRef<[usize]>, allocator: A) -> Self

pub fn zeros_in(sizes: impl AsRef<[usize]>, allocator: A) -> Self

pub fn zeros_in_with_total_capacity( sizes: impl AsRef<[usize]>, allocator: A, ) -> Self

pub fn try_with_sizes_in( sizes: impl AsRef<[usize]>, allocator: A, ) -> Result<Self, TryReserveError>

pub fn reshape_in_place(&mut self, sizes: impl AsRef<[usize]>)

pub fn reshape(self, sizes: impl AsRef<[usize]>) -> Self

pub unsafe fn reshape_unchecked(self, dimensions: Dimensions)

Safety

The caller must ensure that the new dimensions are compatible with the existing dimensions.

pub fn flatten_in_place(&mut self)

pub fn flatten(self) -> Self

pub fn into_buffer(self) -> Buffer<T, A>

pub fn as_buffer(&self) -> &Buffer<T, A>

pub fn as_mut_buffer(&mut self) -> &mut Buffer<T, A>

pub fn backend(&self) -> &A

pub fn shape(&self) -> &Dimensions

pub fn sizes(&self) -> &[usize]

Returns the dimensions of the tensor.

pub fn strides(&self) -> &[usize]

pub fn as_ptr(&self) -> *const T

pub unsafe fn owned_unchecked(&self) -> ManuallyDrop<Self>

Safety

This function is unsafe because it enables bypassing the lifetime of the tensor.

pub unsafe fn owned_unchecked_in( &self, storage_allocator: A, ) -> ManuallyDrop<Self>

Safety

This function is unsafe because it enables bypassing the lifetime of the tensor.

pub fn total_len(&self) -> usize

pub fn as_mut_ptr(&mut self) -> *mut T

pub fn as_view(&self) -> TensorView<'_, T, A>

pub fn as_view_mut(&mut self) -> TensorViewMut<'_, T, A>

pub fn get(&self, index: usize) -> Option<TensorView<'_, T, A>>

pub fn get_mut(&mut self, index: usize) -> Option<TensorViewMut<'_, T, A>>

pub fn split(&self) -> impl Iterator<Item = TensorView<'_, T, A>>

pub fn split_mut(&mut self) -> impl Iterator<Item = TensorViewMut<'_, T, A>>

pub unsafe fn assume_init(&mut self)

Safety

See std::mem::MaybeUninit::assume_init.

pub fn flatten_to_base<F: Field>(self) -> Tensor<F, A>

where T: ExtensionField<F>,

pub fn into_extension<ET: ExtensionField<T>>(self) -> Tensor<ET, A>

where T: Field,

impl<T> Tensor<T, CpuBackend>

pub fn rand<R: Rng>(rng: &mut R, sizes: impl AsRef<[usize]>) -> Self

where Standard: Distribution<T>,

pub fn with_sizes(sizes: impl AsRef<[usize]>) -> Self

pub fn as_slice(&self) -> &[T]

pub fn as_mut_slice(&mut self) -> &mut [T]

impl<T: Field> Tensor<T, CpuBackend>

pub fn sum(&self, dim: usize) -> Tensor<T, CpuBackend>

Computes the sum of the tensor along a dimension.

impl<T, A: TransposeBackend<T>> Tensor<T, A>

pub fn transpose(&self) -> Tensor<T, A>

Returns a new tensor with the last two dimensions transposed.

This function panics if the input tensor is not a 2D tensor.

Trait Implementations

impl<T: Clone, A: Clone + Backend> Clone for Tensor<T, A>

fn clone(&self) -> Tensor<T, A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, A: Debug + Backend> Debug for Tensor<T, A>

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

Formats the value using the given formatter.

impl<T> Default for Tensor<T, CpuBackend>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Tensor<T>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<'a, T, A: Backend> From<&'a Tensor<T, A>> for TensorView<'a, T, A>

fn from(tensor: &'a Tensor<T, A>) -> Self

Converts to this type from the input type.

impl<'a, T, A: Backend> From<&'a mut Tensor<T, A>> for TensorViewMut<'a, T, A>

fn from(tensor: &'a mut Tensor<T, A>) -> Self

Converts to this type from the input type.

impl<T, A: Backend> From<Buffer<T, A>> for Tensor<T, A>

fn from(buffer: Buffer<T, A>) -> Self

Converts to this type from the input type.

impl<T: Clone + Send + Sync> From<DenseMatrix<T>> for Tensor<T, CpuBackend>

fn from(value: RowMajorMatrix<T>) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T>> for Tensor<T, CpuBackend>

fn from(vec: Vec<T>) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for Tensor<T, CpuBackend>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T, A: Backend> HasBackend for Tensor<T, A>

type Backend = A

fn backend(&self) -> &Self::Backend

impl<T, A: Backend, I: AsRef<[usize]>> Index<I> for Tensor<T, A>

type Output = Init<T, A>

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, A: Backend, I: AsRef<[usize]>> IndexMut<I> for Tensor<T, A>

fn index_mut(&mut self, index: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T, A: Backend> PartialEq for Tensor<T, A>

where Buffer<T, A>: PartialEq,

fn eq(&self, __other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Serialize> Serialize for Tensor<T>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T: Clone + Send + Sync> TryFrom<Tensor<T>> for RowMajorMatrix<T>

type Error = DimensionsError

The type returned in the event of a conversion error.

fn try_from(value: Tensor<T, CpuBackend>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T, A: Backend> Eq for Tensor<T, A>

where Buffer<T, A>: Eq,