Skip to main content

TensorRead

Enum TensorRead 

Source
pub enum TensorRead<'a> {
    Tensor(&'a Tensor),
    View(TensorView<'a>),
}
Expand description

Read-only tensor input accepted by synchronous eager kernels.

TensorRead lets kernels accept either an owned tensor reference or a borrowed TensorView without forcing callers to materialize first. The View variant preserves arbitrary strides and offsets, so kernels that support strided reads can consume transposes, slices, and broadcasts directly.

TensorRead is intentionally borrowed. It is an input-dispatch type, not an owned lazy tensor value. APIs that need to store a lazy layout result should keep an owned base tensor plus layout metadata, then expose a TensorRead only for the duration of kernel dispatch.

§Examples

use tenferro_tensor::{DType, Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![2], vec![1.0_f64, 2.0]).unwrap();
let read = TensorRead::from_tensor(&tensor);

assert_eq!(read.dtype(), DType::F64);
assert_eq!(read.shape(), &[2]);

Variants§

§

Tensor(&'a Tensor)

§

View(TensorView<'a>)

Implementations§

Source§

impl<'a> TensorRead<'a>

Source

pub fn try_host(self, op: &'static str) -> Result<TensorView<'a, Host>, Error>

Checked narrowing of a read target to a host-marked view.

This is the boundary a CPU entry point crosses once: an owned tensor is borrowed without copying, an existing view keeps its layout, and the result is a TensorView<'a, Host> whose consumers read host elements without re-checking placement. op names the operation in the error, as the per-entry checks it replaces did.

§Examples
use tenferro_tensor::{DType, Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![2], vec![1.0_f64, 2.0])?;
let host = TensorRead::from_tensor(&tensor).try_host("cholesky")?;
assert_eq!(host.dtype(), DType::F64);
§Errors

Returns crate::Error::UnsupportedDType attributed to op for a tensor built with Tensor::external, which has no preset-scalar view, and crate::Error::RuntimeState attributed to op when the read borrows backend (device) storage; download the tensor to host first.

Source§

impl<'a> TensorRead<'a>

Source

pub fn from_tensor(tensor: &'a Tensor) -> TensorRead<'a>

Borrow an owned tensor as a read target without copying it.

§Examples
use tenferro_tensor::{Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![2], vec![1.0_f64, 2.0])?;
let read = TensorRead::from_tensor(&tensor);
assert_eq!(read.as_slice::<f64>()?, &[1.0, 2.0]);
Source

pub fn from_view(view: TensorView<'a>) -> TensorRead<'a>

Wrap a borrowed dtype-erased view as a read target.

§Examples
use tenferro_tensor::{TensorRead, TensorView};

let read = TensorRead::from_view(TensorView::i32(&[2], &[3, 4])?);
assert_eq!(read.as_slice::<i32>()?, &[3, 4]);
assert!(read.as_tensor().is_none());
Source

pub fn tensor_view(self) -> Option<TensorView<'a>>

Convert this read target into a dtype-erased tensor view, or None when it borrows a tensor with an externally defined payload.

Owned tensors are borrowed without copying their storage. Existing views are returned as is, preserving their layout and placement metadata. TensorView has one variant per preset scalar (F32 … C64) and none for a caller-owned element type, so a tensor built from Tensor::external has no view; read it through Tensor::external_payload instead.

§Examples
use tenferro_tensor::{DynRank, ErasedHostTensor, Host, Tensor, TensorRead, TypedTensor};

let tensor = Tensor::from_vec_col_major(vec![2], vec![1.0_f64, 2.0])?;
let view = TensorRead::from_tensor(&tensor)
    .tensor_view()
    .ok_or("a preset f64 tensor has a view")?;
assert_eq!(view.shape(), &[2]);
assert_eq!(view.as_slice::<f64>()?, &[1.0, 2.0]);

let payload = ErasedHostTensor::new(
    TypedTensor::<f64, DynRank, Host>::from_host_vec_col_major(vec![2], vec![1.0, 2.0])?,
);
let external = Tensor::external(payload);
assert!(TensorRead::from_tensor(&external).tensor_view().is_none());
Source

pub fn as_slice<T>(&self) -> Result<&'a [T], Error>
where T: TensorScalar,

Borrow this read target as a typed compact host slice without allocation.

This delegates to TensorView::as_slice. Cloning a TensorRead is a shallow clone of its borrowed reference or view metadata, so the returned slice retains the original 'a storage lifetime and never outlives the storage borrowed by this read target. This method does not materialize, transfer, or otherwise canonicalize the input.

§Errors

Returns ValidationError::DTypeMismatch when T does not match the input dtype, ValidationError::NonContiguousViewAsSlice for a noncompact view, a typed runtime-state host-access error for backend-owned storage, or crate::Error::UnsupportedDType for a tensor built with Tensor::external, which has no preset-scalar view. Backend-owned inputs are never downloaded implicitly.

§Examples
use tenferro_tensor::{Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![2], vec![1.0_f64, 2.0])?;
let read = TensorRead::from_tensor(&tensor);
assert_eq!(read.as_slice::<f64>()?, &[1.0, 2.0]);
Source

pub fn dtype(&self) -> DType

Return the element dtype of this read target.

§Examples
use tenferro_tensor::{DType, Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![1], vec![1_i64])?;
assert_eq!(TensorRead::from_tensor(&tensor).dtype(), DType::I64);
Source

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

Return the logical shape of this read target.

§Examples
use tenferro_tensor::{Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![2, 1], vec![1.0_f64, 2.0])?;
assert_eq!(TensorRead::from_tensor(&tensor).shape(), &[2, 1]);
Source

pub fn placement(&self) -> &Placement

Return the placement metadata carried by this read target.

§Examples
use tenferro_tensor::{MemoryKind, Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![1], vec![1.0_f64])?;
let read = TensorRead::from_tensor(&tensor);
assert_eq!(read.placement().memory_kind, MemoryKind::UnpinnedHost);
Source

pub fn is_host_memory(&self) -> bool

Return whether this read target borrows host-addressed memory.

The one host/device answer a CPU entry point needs, decided by the payload and never by Placement::memory_kind; it is the same answer Self::try_host acts on, and the same one TypedTensor::is_host_memory gives for an owner.

§Examples
use tenferro_tensor::{Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![1], vec![1.0_f64])?;
assert!(TensorRead::from_tensor(&tensor).is_host_memory());
Source

pub fn backend_family(&self) -> Option<&'static str>

Return the physical backend family of this read target, when backend-owned.

§Examples
use tenferro_tensor::{Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![1], vec![1.0_f64])?;
assert_eq!(TensorRead::from_tensor(&tensor).backend_family(), None);
Source

pub fn allocation_domain(&self) -> Option<AllocationDomainId>

Return the shared allocation domain of this read target, when present.

§Examples
use tenferro_tensor::{Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![1], vec![1.0_f64])?;
assert_eq!(TensorRead::from_tensor(&tensor).allocation_domain(), None);
Source

pub fn strides(&self) -> Result<Vec<isize>, Error>

Return strides in element units; owned tensors report compact column-major strides.

§Examples
use tenferro_tensor::{Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![2, 3], vec![0.0_f64; 6])?;
assert_eq!(TensorRead::from_tensor(&tensor).strides()?, vec![1, 2]);
§Errors

Returns crate::Error::Validation with tenferro_tensor_core::ValidationError::IntegerOverflow when column-major stride arithmetic overflows.

Source

pub fn offset(&self) -> isize

Return the physical element offset; owned tensors always start at 0.

§Examples
use tenferro_tensor::{TensorRead, TensorView, TypedTensorView};

let data = [1.0_f64, 2.0, 3.0];
let view = TensorView::F64(TypedTensorView::from_slice(vec![2], vec![1], 1, &data)?);
assert_eq!(TensorRead::from_view(view).offset(), 1);
Source

pub fn layout_linear_offset(&self, indices: &[usize]) -> Result<usize, Error>

Compute the physical element offset for a logical index.

§Examples
use tenferro_tensor::{Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![2, 3], vec![0.0_f64; 6])?;
let read = TensorRead::from_tensor(&tensor);
assert_eq!(read.layout_linear_offset(&[1, 2])?, 5);
assert!(read.layout_linear_offset(&[2, 0]).is_err());
§Errors

Returns crate::Error::Validation with tenferro_tensor_core::ValidationError::RankMismatch when indices has the wrong rank, tenferro_tensor_core::ValidationError::InvalidArgument when an index is outside its axis extent, or tenferro_tensor_core::ValidationError::IntegerOverflow when offset arithmetic overflows.

Source

pub fn is_col_major_contiguous(&self) -> Result<bool, Error>

Return whether this read target is compact column-major.

§Examples
use tenferro_tensor::{Tensor, TensorRead, TensorView, TypedTensorView};

let tensor = Tensor::from_vec_col_major(vec![2], vec![1.0_f64, 2.0])?;
assert!(TensorRead::from_tensor(&tensor).is_col_major_contiguous()?);
let data = [1.0_f64, 2.0, 3.0];
let strided = TensorView::F64(TypedTensorView::from_slice(vec![2], vec![2], 0, &data)?);
assert!(!TensorRead::from_view(strided).is_col_major_contiguous()?);
§Errors

Returns crate::Error::Validation with tenferro_tensor_core::ValidationError::IntegerOverflow when compactness arithmetic overflows.

Source

pub fn layout_summary(&self) -> String

Return a compact string summary of this read target’s layout metadata.

§Examples
use tenferro_tensor::{Tensor, TensorRead};

let tensor = Tensor::from_vec_col_major(vec![2], vec![1.0_f64, 2.0])?;
assert_eq!(
    TensorRead::from_tensor(&tensor).layout_summary(),
    "shape=[2] strides=[1] offset=0"
);
Source

pub fn assert_col_major_contiguous(&self) -> Result<(), Error>

Assert this read target is compact column-major.

§Examples
use tenferro_tensor::{Tensor, TensorRead, TensorView, TypedTensorView};

let tensor = Tensor::from_vec_col_major(vec![2], vec![1.0_f64, 2.0])?;
TensorRead::from_tensor(&tensor).assert_col_major_contiguous()?;
let data = [1.0_f64, 2.0, 3.0];
let strided = TensorView::F64(TypedTensorView::from_slice(vec![2], vec![2], 0, &data)?);
assert!(TensorRead::from_view(strided).assert_col_major_contiguous().is_err());
§Errors

Returns crate::Error::Validation with tenferro_tensor_core::ValidationError::IntegerOverflow when compactness arithmetic overflows, or tenferro_tensor_core::ValidationError::InvalidArgument when the view is not compact column-major.

Source

pub fn as_tensor(&self) -> Option<&'a Tensor>

Return the borrowed owned tensor, or None when this read target is a view.

§Examples
use tenferro_tensor::{Tensor, TensorRead, TensorView};

let tensor = Tensor::from_vec_col_major(vec![1], vec![1.0_f64])?;
assert!(TensorRead::from_tensor(&tensor).as_tensor().is_some());
assert!(TensorRead::from_view(TensorView::f64(&[1], &[1.0])?).as_tensor().is_none());

Trait Implementations§

Source§

impl AsView for TensorRead<'_>

Source§

type Repr = Erased

The representation results take for this input.
Source§

fn as_read(&self) -> TensorRead<'_>

Borrow this input as a TensorRead. Metadata only; never copies element data. Read more
Source§

impl<'a> Clone for TensorRead<'a>

Source§

fn clone(&self) -> TensorRead<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for TensorRead<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for TensorRead<'a>

§

impl<'a> !UnwindSafe for TensorRead<'a>

§

impl<'a> Freeze for TensorRead<'a>

§

impl<'a> Send for TensorRead<'a>

§

impl<'a> Sync for TensorRead<'a>

§

impl<'a> Unpin for TensorRead<'a>

§

impl<'a> UnsafeUnpin for TensorRead<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<X> CoreOps for X
where X: AsView + ?Sized,

Source§

fn exp( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise exponential. Read more
Source§

fn neg( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise negation. Read more
Source§

fn sign( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise sign. Read more
Source§

fn conj( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise complex conjugate (identity on real dtypes). Read more
Source§

fn log( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise natural logarithm. Read more
Source§

fn expm1( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise exp(x) - 1. Read more
Source§

fn log1p( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise log(1 + x). Read more
Source§

fn erf( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise error function. Read more
Source§

fn sin( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise sine. Read more
Source§

fn cos( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise cosine. Read more
Source§

fn tanh( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise hyperbolic tangent. Read more
Source§

fn sqrt( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise square root. Read more
Source§

fn rsqrt( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise reciprocal square root. Read more
Source§

fn abs( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as CoreRepr>::Real, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise absolute value; complex inputs return their modulus. Read more
Source§

fn sigmoid( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Logistic sigmoid. Read more
Source§

fn silu( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

SiLU (x * sigmoid(x)). Read more
Source§

fn softplus( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Softplus log(1 + exp(x)). Read more
Source§

fn gelu( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

GELU with the exact error function. Read more
Source§

fn gelu_tanh( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

GELU with the tanh approximation. Read more
Source§

fn mul( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise product with broadcasting. Read more
Source§

fn sub( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise difference with broadcasting. Read more
Source§

fn div( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise quotient with broadcasting. Read more
Source§

fn rem( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise remainder with broadcasting. Read more
Source§

fn pow( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise power with broadcasting. Read more
Source§

fn maximum( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise maximum with broadcasting. Read more
Source§

fn minimum( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise minimum with broadcasting. Read more
Source§

fn add( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise sum with broadcasting. Read more
Source§

fn add_into( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, dest: Dest<<<X as AsView>::Repr as Repr>::Write<'_>>, ) -> Result<(), Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise sum with broadcasting. Read more
Source§

fn matmul( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Matrix product of the two leading axes, batched over trailing axes. Read more
Source§

fn compare( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, dir: CompareDir, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as CoreRepr>::Bool, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise comparison with broadcasting; returns a bool tensor. Read more
Source§

fn clamp( &self, lower: &impl AsView<Repr = <X as AsView>::Repr>, upper: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Elementwise clamp to [lower, upper] with broadcasting. Read more
Source§

fn where_select<Y>( &self, on_true: &Y, on_false: &impl AsView<Repr = <Y as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<Y as AsView>::Repr as Repr>::Value, Error>
where Y: SelectOperand<<X as AsView>::Repr> + ?Sized, <X as AsView>::Repr: CoreRepr,

Elementwise selection: on_true where the receiver is true, on_false elsewhere, with broadcasting. The receiver is the bool condition; a typed receiver must be TypedTensor<bool>. Read more
Source§

fn dot_general( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, config: DotGeneralConfig, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

General contraction with batch dimensions (DotGeneralConfig); DotGeneralOptions conjugates an operand. Read more
Source§

fn dot_general_with( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, config: DotGeneralConfig, options: &DotGeneralOptions, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

General contraction with batch dimensions (DotGeneralConfig); DotGeneralOptions conjugates an operand. Read more
Source§

fn reduce_sum( &self, axes: Option<&[isize]>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Sum over axes (None: every axis); axes are signed, -1 is the last axis. Read more
Source§

fn reduce_max( &self, axes: Option<&[isize]>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Maximum over axes (None: every axis); axes are signed, -1 is the last axis. Read more
Source§

fn reduce_min( &self, axes: Option<&[isize]>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Minimum over axes (None: every axis); axes are signed, -1 is the last axis. Read more
Source§

fn reduce_prod( &self, axes: Option<&[isize]>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Product over axes (None: every axis); axes are signed, -1 is the last axis. Read more
Source§

fn reduce_sum_squares( &self, axes: Option<&[isize]>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Sum of squared magnitudes over axes (None: every axis); axes are signed, -1 is the last axis. Read more
Source§

fn reduce_mean( &self, axes: Option<&[isize]>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Mean over axes (None: every axis); axes are signed, -1 is the last axis. Read more
Source§

fn reshape( &self, shape: &[usize], exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Reshape to shape in column-major element order. Read more
Source§

fn broadcast_in_dim( &self, shape: &[usize], dims: &[usize], exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Broadcast to shape; dims[i] is the output axis of input axis i (an IR-level dimension map, unsigned like the *Config structs). Read more
Source§

fn transpose( &self, perm: &[isize], exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Permute axes; perm is signed (-1 is the last axis). Read more
Source§

fn reverse( &self, axes: &[isize], exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Reverse the order of elements along axes (signed). Read more
Source§

fn tril( &self, k: i64, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Lower triangle of the two leading axes relative to diagonal k. Read more
Source§

fn triu( &self, k: i64, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Upper triangle of the two leading axes relative to diagonal k. Read more
Source§

fn extract_diag( &self, axis_a: isize, axis_b: isize, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Extract the diagonal of axes axis_a and axis_b (signed). Read more
Source§

fn embed_diag( &self, axis_a: isize, axis_b: isize, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Embed axis axis_a of the receiver as the diagonal of a new axis pair; axis_b (signed, against the output rank) is the position of the inserted axis. Read more
Source§

fn slice( &self, config: SliceConfig, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Static strided slice (SliceConfig). Read more
Source§

fn pad( &self, config: PadConfig, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Pad with edge and interior padding (PadConfig). Read more
Source§

fn gather( &self, indices: &impl AsView, config: GatherConfig, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

XLA-style gather (GatherConfig); indices is an integer tensor of any representation. Read more
Source§

fn scatter( &self, indices: &impl AsView, updates: &impl AsView, config: ScatterConfig, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

XLA-style scatter (ScatterConfig); indices and updates may have any representation. Read more
Source§

fn dynamic_slice( &self, starts: &impl AsView, sizes: &[usize], exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Slice of sizes starting at the run-time starts (an integer vector). Read more
Source§

fn dynamic_update_slice( &self, update: &impl AsView<Repr = <X as AsView>::Repr>, starts: &impl AsView, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Copy of the receiver with update written at the run-time starts. Read more
Source§

fn concatenate( inputs: &[&X], axis: isize, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr, X: Sized,

Concatenate inputs along axis (signed). Called as CoreOps::concatenate(&[&a, &b], axis, exec). Read more
Source§

fn convert(&self, to: DType, exec: &mut dyn Engine) -> Result<Tensor, Error>
where <X as AsView>::Repr: CoreRepr,

Checked dtype conversion along tenferro’s promotion lattice. The result is a dtype-erased Tensor because its dtype is a run-time value. Read more
Source§

fn cast(&self, to: DType, exec: &mut dyn Engine) -> Result<Tensor, Error>
where <X as AsView>::Repr: CoreRepr,

Explicit, possibly lossy dtype projection. The result is a dtype-erased Tensor because its dtype is a run-time value. Read more
Source§

fn scale_real( &self, factor: f64, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Multiply by a real scalar. Read more
Source§

fn scale_complex( &self, factor: Complex<f64>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Multiply by a complex scalar. Read more
Source§

fn softmax( &self, axis: isize, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Softmax along axis (signed). Read more
Source§

fn log_softmax( &self, axis: isize, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Log-softmax along axis (signed). Read more
Source§

fn masked_softmax( &self, mask: &impl AsView, axis: isize, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Softmax along axis over the entries where mask is true. Read more
Source§

fn masked_log_softmax( &self, mask: &impl AsView, axis: isize, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Log-softmax along axis over the entries where mask is true. Read more
Source§

fn take_along_axis( &self, indices: &impl AsView, axis: isize, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Gather along axis (signed) with per-position integer indices. Read more
Source§

fn layer_norm( &self, axis: isize, weight: Option<&X>, bias: Option<&X>, eps: f64, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

Layer normalization over axis (signed) with optional affine weight and bias. Read more
Source§

fn rms_norm( &self, axis: isize, weight: Option<&X>, bias: Option<&X>, eps: f64, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: CoreRepr,

RMS normalization over axis (signed) with optional affine weight and bias. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<X> LinalgOps for X
where X: AsView + ?Sized,

Source§

fn svd( &self, exec: &mut dyn Engine, ) -> Result<Svd<<<X as AsView>::Repr as Repr>::Value, <<X as AsView>::Repr as LinalgRepr>::Real>, Error>
where <X as AsView>::Repr: LinalgRepr,

Singular value decomposition a = u diag(s) vh; SvdShape::Full returns the full-matrices factors. Read more
Source§

fn svd_with( &self, options: &SvdOptions, exec: &mut dyn Engine, ) -> Result<Svd<<<X as AsView>::Repr as Repr>::Value, <<X as AsView>::Repr as LinalgRepr>::Real>, Error>
where <X as AsView>::Repr: LinalgRepr,

Singular value decomposition a = u diag(s) vh; SvdShape::Full returns the full-matrices factors. Read more
Source§

fn svdvals( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as LinalgRepr>::Real, Error>
where <X as AsView>::Repr: LinalgRepr,

Singular values only, in descending order. Read more
Source§

fn svdvals_with( &self, options: &SvdvalsOptions, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as LinalgRepr>::Real, Error>
where <X as AsView>::Repr: LinalgRepr,

Singular values only, in descending order. Read more
Source§

fn qr( &self, exec: &mut dyn Engine, ) -> Result<Qr<<<X as AsView>::Repr as Repr>::Value>, Error>
where <X as AsView>::Repr: LinalgRepr,

Thin QR factorization a = q r. Read more
Source§

fn qr_with( &self, options: &QrOptions, exec: &mut dyn Engine, ) -> Result<Qr<<<X as AsView>::Repr as Repr>::Value>, Error>
where <X as AsView>::Repr: LinalgRepr,

Thin QR factorization a = q r. Read more
Source§

fn householder_qr( &self, exec: &mut dyn Engine, ) -> Result<HouseholderQr<<<X as AsView>::Repr as Repr>::Value>, Error>
where <X as AsView>::Repr: LinalgRepr,

Compact Householder QR: an opaque factorization state from which r and q_columns are extracted. Read more
Source§

fn rank_revealing_qr( &self, exec: &mut dyn Engine, ) -> Result<RankRevealingQrResult<<<X as AsView>::Repr as Repr>::Value, <<X as AsView>::Repr as LinalgRepr>::Index>, Error>
where <X as AsView>::Repr: LinalgRepr,

Column-pivoted QR with a numerical rank: q, r, column_permutation and rank. Read more
Source§

fn rank_revealing_qr_with( &self, options: &RankRevealingQrOptions, exec: &mut dyn Engine, ) -> Result<RankRevealingQrResult<<<X as AsView>::Repr as Repr>::Value, <<X as AsView>::Repr as LinalgRepr>::Index>, Error>
where <X as AsView>::Repr: LinalgRepr,

Column-pivoted QR with a numerical rank: q, r, column_permutation and rank. Read more
Source§

fn lu( &self, exec: &mut dyn Engine, ) -> Result<Lu<<<X as AsView>::Repr as Repr>::Value>, Error>
where <X as AsView>::Repr: LinalgRepr,

Partial-pivot LU a = p l u; p is a permutation matrix and parity is the real sign of the permutation. Read more
Source§

fn full_piv_lu( &self, exec: &mut dyn Engine, ) -> Result<FullPivLu<<<X as AsView>::Repr as Repr>::Value, <<X as AsView>::Repr as LinalgRepr>::Real>, Error>
where <X as AsView>::Repr: LinalgRepr,

Complete-pivot LU a = p l u q; p and q are permutation matrices and parity is the real sign of the permutations. Read more
Source§

fn full_piv_lu_solve( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Solves a x = b through the complete-pivot LU of a; a rank-deficient system is rejected. Read more
Source§

fn solve( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Solves a x = b with a partial-pivot LU of a; solve_into overwrites a destination. Read more
Source§

fn solve_into( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, dest: Dest<<<X as AsView>::Repr as Repr>::Write<'_>>, ) -> Result<(), Error>
where <X as AsView>::Repr: LinalgRepr,

Solves a x = b with a partial-pivot LU of a; solve_into overwrites a destination. Read more
Source§

fn lstsq( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Least-squares solution of a x = b for a tall or square, full-column-rank a (thin QR, then a triangular solve). Read more
Source§

fn triangular_solve( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Solves a triangular system with a (or its transpose) on the chosen side; only the selected triangle of a is read. Read more
Source§

fn triangular_solve_with( &self, b: &impl AsView<Repr = <X as AsView>::Repr>, options: &TriangularSolveOptions, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Solves a triangular system with a (or its transpose) on the chosen side; only the selected triangle of a is read. Read more
Source§

fn cholesky( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Lower Cholesky factor l of a Hermitian positive-definite matrix, a = l l^H. Read more
Source§

fn cholesky_with( &self, options: &CholeskyOptions, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Lower Cholesky factor l of a Hermitian positive-definite matrix, a = l l^H. Read more
Source§

fn eig( &self, exec: &mut dyn Engine, ) -> Result<Eig<<<X as AsView>::Repr as LinalgRepr>::Complex>, Error>
where <X as AsView>::Repr: LinalgRepr,

General eigendecomposition a v = v diag(values); eigenvectors have unit 2-norm. Read more
Source§

fn eigvals( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as LinalgRepr>::Complex, Error>
where <X as AsView>::Repr: LinalgRepr,

Eigenvalues of a general matrix, as complex numbers. Read more
Source§

fn eigh( &self, exec: &mut dyn Engine, ) -> Result<Eigh<<<X as AsView>::Repr as Repr>::Value, <<X as AsView>::Repr as LinalgRepr>::Real>, Error>
where <X as AsView>::Repr: LinalgRepr,

Eigendecomposition of a Hermitian matrix (the lower triangle is read); values are real and ascending. Read more
Source§

fn eigh_with( &self, options: &EighOptions, exec: &mut dyn Engine, ) -> Result<Eigh<<<X as AsView>::Repr as Repr>::Value, <<X as AsView>::Repr as LinalgRepr>::Real>, Error>
where <X as AsView>::Repr: LinalgRepr,

Eigendecomposition of a Hermitian matrix (the lower triangle is read); values are real and ascending. Read more
Source§

fn eigvalsh( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as LinalgRepr>::Real, Error>
where <X as AsView>::Repr: LinalgRepr,

Eigenvalues of a Hermitian matrix (the lower triangle is read), real and ascending. Read more
Source§

fn eigvalsh_with( &self, options: &EigvalshOptions, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as LinalgRepr>::Real, Error>
where <X as AsView>::Repr: LinalgRepr,

Eigenvalues of a Hermitian matrix (the lower triangle is read), real and ascending. Read more
Source§

fn slogdet( &self, exec: &mut dyn Engine, ) -> Result<Slogdet<<<X as AsView>::Repr as Repr>::Value, <<X as AsView>::Repr as LinalgRepr>::Real>, Error>
where <X as AsView>::Repr: LinalgRepr,

Sign and natural log of the absolute determinant of a square matrix. Read more
Source§

fn det( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Determinant of a square matrix, computed as sign * exp(log_abs_det). Read more
Source§

fn inv( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Inverse of a square matrix (a solve against the identity). Read more
Source§

fn pinv( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Moore-Penrose pseudoinverse through the SVD; singular values below rtol * max(s) are dropped. Read more
Source§

fn pinv_with( &self, options: &PinvOptions, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as Repr>::Value, Error>
where <X as AsView>::Repr: LinalgRepr,

Moore-Penrose pseudoinverse through the SVD; singular values below rtol * max(s) are dropped. Read more
Source§

fn norm( &self, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as LinalgRepr>::Real, Error>
where <X as AsView>::Repr: LinalgRepr,

Vector or matrix norm over the chosen axes, selected by NormOrd; NormOrd::Zero counts entries != 0 (NaN counts as nonzero). Read more
Source§

fn norm_with( &self, options: &NormOptions, exec: &mut dyn Engine, ) -> Result<<<X as AsView>::Repr as LinalgRepr>::Real, Error>
where <X as AsView>::Repr: LinalgRepr,

Vector or matrix norm over the chosen axes, selected by NormOrd; NormOrd::Zero counts entries != 0 (NaN counts as nonzero). Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<Y, C> SelectOperand<C> for Y
where Y: AsView + ?Sized, C: SelectCondition,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.