Skip to main content

SymDim

Struct SymDim 

pub struct SymDim(/* private fields */);
Expand description

A symbolic tensor dimension expression used to build shape-agnostic graphs.

SymDim values can be combined with basic arithmetic and later resolved against op-local [DimExpr] expressions when shape metadata is propagated.

§Examples

use tenferro_ops::sym_dim::SymDim;

let rows = SymDim::from(3usize);
let cols = SymDim::from(4usize);
let area = rows * cols;

Implementations§

§

impl SymDim

pub fn min(self, other: impl Into<SymDim>) -> SymDim

Return the smaller of two symbolic dimensions.

§Examples
use tenferro_ops::sym_dim::SymDim;

let clipped = SymDim::from(5usize).min(8usize);

pub fn max(self, other: impl Into<SymDim>) -> SymDim

Return the larger of two symbolic dimensions.

§Examples
use tenferro_ops::sym_dim::SymDim;

let batch = SymDim::from(2usize).max(1usize);

pub fn referenced_tensor_ids(&self) -> Vec<u64>

Collect the unique traced tensor IDs referenced by TensorAxis variants inside this expression, in traversal order (first occurrence wins).

Used by traced composition wrappers that build multi-input ops from SymDim-valued target shapes — e.g. TracedTensor::broadcast_in_dim_sym.

§Examples
use tenferro_ops::sym_dim::SymDim;

let lhs = SymDim::tensor_axis(7, 0);
let rhs = SymDim::tensor_axis(9, 1);
let sum = lhs + rhs;
assert_eq!(sum.referenced_tensor_ids(), vec![7, 9]);

Trait Implementations§

§

impl Add<usize> for SymDim

§

type Output = SymDim

The resulting type after applying the + operator.
§

fn add(self, rhs: usize) -> <SymDim as Add<usize>>::Output

Performs the + operation. Read more
§

impl Add for SymDim

§

type Output = SymDim

The resulting type after applying the + operator.
§

fn add(self, rhs: SymDim) -> <SymDim as Add>::Output

Performs the + operation. Read more
§

impl Clone for SymDim

§

fn clone(&self) -> SymDim

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for SymDim

§

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

Formats the value using the given formatter. Read more
§

impl Div<usize> for SymDim

§

type Output = SymDim

The resulting type after applying the / operator.
§

fn div(self, rhs: usize) -> <SymDim as Div<usize>>::Output

Performs the / operation. Read more
§

impl Div for SymDim

§

type Output = SymDim

The resulting type after applying the / operator.
§

fn div(self, rhs: SymDim) -> <SymDim as Div>::Output

Performs the / operation. Read more
§

impl From<usize> for SymDim

§

fn from(value: usize) -> SymDim

Converts to this type from the input type.
§

impl Mul<usize> for SymDim

§

type Output = SymDim

The resulting type after applying the * operator.
§

fn mul(self, rhs: usize) -> <SymDim as Mul<usize>>::Output

Performs the * operation. Read more
§

impl Mul for SymDim

§

type Output = SymDim

The resulting type after applying the * operator.
§

fn mul(self, rhs: SymDim) -> <SymDim as Mul>::Output

Performs the * operation. Read more
§

impl PartialEq for SymDim

§

fn eq(&self, other: &SymDim) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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 Sub<usize> for SymDim

§

type Output = SymDim

The resulting type after applying the - operator.
§

fn sub(self, rhs: usize) -> <SymDim as Sub<usize>>::Output

Performs the - operation. Read more
§

impl Sub for SymDim

§

type Output = SymDim

The resulting type after applying the - operator.
§

fn sub(self, rhs: SymDim) -> <SymDim as Sub>::Output

Performs the - operation. Read more
§

impl Eq for SymDim

§

impl StructuralPartialEq for SymDim

Auto Trait Implementations§

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
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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.