Enum TDim 

pub enum TDim {
    Val(i64),
    Sym(Symbol),
    Add(Vec<TDim>),
    Mul(Vec<TDim>),
    MulInt(i64, Box<TDim>),
    Div(Box<TDim>, u64),
    Broadcast(Vec<TDim>),
    Min(Vec<TDim>),
    Max(Vec<TDim>),
    Ge(Box<TDim>, Box<TDim>),
    Eq(Box<TDim>, Box<TDim>),
}

Variants

Val(i64)

Sym(Symbol)

Add(Vec<TDim>)

Mul(Vec<TDim>)

MulInt(i64, Box<TDim>)

Div(Box<TDim>, u64)

Broadcast(Vec<TDim>)

Min(Vec<TDim>)

Max(Vec<TDim>)

Ge(Box<TDim>, Box<TDim>)

Comparison: evaluates to 1 (true) or 0 (false). lhs >= rhs

Eq(Box<TDim>, Box<TDim>)

Comparison: evaluates to 1 (true) or 0 (false). lhs == rhs

Implementations

impl TDim

pub fn is_one(&self) -> bool

pub fn to_i64(&self) -> TractResult<i64>

pub fn as_i64(&self) -> Option<i64>

pub fn eval_to_i64(&self, values: &SymbolValues) -> TractResult<i64>

pub fn eval(&self, values: &SymbolValues) -> TDim

pub fn eval_with_scenario(&self, scenario: &str) -> TDim

pub fn substitute(&self, from: &Symbol, to: &Self) -> TractResult<Self>

pub fn substitute_all(&self, map: &HashMap<Symbol, Self>) -> TractResult<Self>

pub fn reduce(self) -> TDim

pub fn find_scope(&self) -> Option<SymbolScope>

pub fn expand_polynomial(self) -> TDim

Fully distribute every Mul of Adds in self into a flat sum of products, then simplify. Used to compare two algebraically equal but differently-factored TDims for equality (e.g. Reshape volume checks on graphs where the same dimension is built two ways).

Cost can blow up combinatorially on very deeply factored expressions — call this only at boundaries where structural equality is needed, not as a general-purpose simplifier.

pub fn simplify(self) -> TDim

pub fn simplify_with_extra_assertions(self, extra: &[Assertion]) -> TDim

pub fn low_inclusive_bound(&self) -> Option<i64>

pub fn high_inclusive_bound(&self) -> Option<i64>

pub fn prove_positive_or_zero(&self) -> bool

pub fn prove_strict_positive(&self) -> bool

pub fn prove_negative_or_zero(&self) -> bool

pub fn prove_strict_negative(&self) -> bool

pub fn lcm(&self, other: &TDim) -> Option<TDim>

Least common multiple of two TDims when both reduce to positive integers.

Returns Val(0) if either operand is 0, and None if either is symbolic, negative, or if the LCM would overflow i64. Callers that need a safe answer for symbolic operands should fall back at the call site.

pub fn gcd(&self) -> u64

pub fn div_ceil(self, rhs: u64) -> TDim

pub fn guess_slope(&self, sym: &Symbol) -> (i64, u64)

pub fn symbols(&self) -> HashSet<Symbol>

pub fn compatible_with(&self, other: &TDim) -> bool

Trait Implementations

impl<'a> Add<&'a TDim> for TDim

type Output = TDim

The resulting type after applying the + operator.

fn add(self, rhs: &'a TDim) -> Self

Performs the + operation.

impl<I> Add<I> for TDim

where I: Into<TDim>,

type Output = TDim

The resulting type after applying the + operator.

fn add(self, rhs: I) -> Self

Performs the + operation.

impl<'a> AddAssign<&'a TDim> for TDim

fn add_assign(&mut self, rhs: &'a TDim)

Performs the += operation.

impl<I> AddAssign<I> for TDim

where I: Into<TDim>,

fn add_assign(&mut self, rhs: I)

Performs the += operation.

impl Bounded for TDim

fn min_value() -> Self

Returns the smallest finite number this type can represent

fn max_value() -> Self

Returns the largest finite number this type can represent

impl Clone for TDim

fn clone(&self) -> TDim

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Datum for TDim

fn name() -> &'static str

fn datum_type() -> DatumType

fn is<D: Datum>() -> bool

impl Debug for TDim

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

Formats the value using the given formatter.

impl Default for TDim

fn default() -> TDim

Returns the “default value” for a type.

impl DimLike for TDim

fn maybe_div(&self, other: &Self) -> TractResult<(Self, u64)>

fn to_i64(&self) -> TractResult<i64>

Convert to regular integer.

fn eval(&self, values: &SymbolValues) -> Self

Substitute as many symbols as possible in the dim value.

fn substitute(&self, from: &Symbol, to: &Self) -> TractResult<Self>

fn substitute_all(&self, map: &HashMap<Symbol, Self>) -> TractResult<Self>

fn eval_to_i64(&self, values: &SymbolValues) -> TractResult<i64>

Full evaluation of the symbol, failing if a symbol is missing

fn broadcast(self, other: Self) -> TractResult<Self>

fn compatible_with(&self, other: &Self) -> bool

fn mini(self, other: Self) -> Self

fn maxi(self, other: Self) -> Self

fn divceil(&self, other: usize) -> Self

Integer divise, rounding up to next integer.

fn to_usize(&self) -> TractResult<usize>

fn to_isize(&self) -> TractResult<isize>

fn to_i32(&self) -> TractResult<i32>

impl Display for TDim

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

Formats the value using the given formatter.

impl<I: AsPrimitive<u64> + PrimInt> Div<I> for TDim

type Output = TDim

The resulting type after applying the / operator.

fn div(self, rhs: I) -> Self

Performs the / operation.

impl<I: AsPrimitive<u64> + PrimInt> DivAssign<I> for TDim

fn div_assign(&mut self, rhs: I)

Performs the /= operation.

impl<'a> From<&'a Symbol> for TDim

fn from(it: &'a Symbol) -> Self

Converts to this type from the input type.

impl<'a> From<&'a i32> for TDim

fn from(v: &'a i32) -> TDim

Converts to this type from the input type.

impl<'a> From<&'a i64> for TDim

fn from(v: &'a i64) -> TDim

Converts to this type from the input type.

impl<'a> From<&'a isize> for TDim

fn from(v: &'a isize) -> TDim

Converts to this type from the input type.

impl<'a> From<&'a u64> for TDim

fn from(v: &'a u64) -> TDim

Converts to this type from the input type.

impl<'a> From<&'a usize> for TDim

fn from(v: &'a usize) -> TDim

Converts to this type from the input type.

impl From<Symbol> for TDim

fn from(it: Symbol) -> Self

Converts to this type from the input type.

impl From<TDim> for Tensor

fn from(it: TDim) -> Tensor

Converts to this type from the input type.

impl From<i32> for TDim

fn from(v: i32) -> TDim

Converts to this type from the input type.

impl From<i64> for TDim

fn from(v: i64) -> TDim

Converts to this type from the input type.

impl From<isize> for TDim

fn from(v: isize) -> TDim

Converts to this type from the input type.

impl From<u64> for TDim

fn from(v: u64) -> TDim

Converts to this type from the input type.

impl From<usize> for TDim

fn from(v: usize) -> TDim

Converts to this type from the input type.

impl Hash for TDim

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Mul<&'a TDim> for TDim

type Output = TDim

The resulting type after applying the * operator.

fn mul(self, rhs: &'a TDim) -> Self

Performs the * operation.

impl<I: Into<TDim>> Mul<I> for TDim

type Output = TDim

The resulting type after applying the * operator.

fn mul(self, rhs: I) -> Self

Performs the * operation.

impl<'a> MulAssign<&'a TDim> for TDim

fn mul_assign(&mut self, rhs: &'a TDim)

Performs the *= operation.

impl<I: Into<TDim>> MulAssign<I> for TDim

fn mul_assign(&mut self, rhs: I)

Performs the *= operation.

impl Neg for TDim

type Output = TDim

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl One for TDim

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl PartialEq for TDim

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<'a> Product<&'a TDim> for TDim

fn product<I: Iterator<Item = &'a TDim>>(iter: I) -> TDim

Takes an iterator and generates Self from the elements by multiplying the items.

impl Product for TDim

fn product<I: Iterator<Item = TDim>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl<I: AsPrimitive<u64> + PrimInt> Rem<I> for TDim

type Output = TDim

The resulting type after applying the % operator.

fn rem(self, rhs: I) -> Self

Performs the % operation.

impl<I: AsPrimitive<u64> + PrimInt> RemAssign<I> for TDim

fn rem_assign(&mut self, rhs: I)

Performs the %= operation.

impl<'a> Sub<&'a TDim> for TDim

type Output = TDim

The resulting type after applying the - operator.

fn sub(self, rhs: &'a TDim) -> Self

Performs the - operation.

impl<I> Sub<I> for TDim

where I: Into<TDim>,

type Output = TDim

The resulting type after applying the - operator.

fn sub(self, rhs: I) -> Self

Performs the - operation.

impl<'a> SubAssign<&'a TDim> for TDim

fn sub_assign(&mut self, rhs: &'a TDim)

Performs the -= operation.

impl<I> SubAssign<I> for TDim

where I: Into<TDim>,

fn sub_assign(&mut self, rhs: I)

Performs the -= operation.

impl<'a> Sum<&'a TDim> for TDim

fn sum<I: Iterator<Item = &'a TDim>>(iter: I) -> TDim

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for TDim

fn sum<I: Iterator<Item = TDim>>(iter: I) -> TDim

Takes an iterator and generates Self from the elements by “summing up” the items.

impl ToDim for &TDim

fn to_dim(&self) -> TDim

Convert self to a TDim.

impl<'a> TryFrom<&'a TDim> for TDim

type Error = Error

The type returned in the event of a conversion error.

fn try_from(d: &'a TDim) -> TractResult<TDim>

Performs the conversion.

impl<'a> TryFrom<&'a TDim> for usize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(d: &'a TDim) -> TractResult<usize>

Performs the conversion.

impl Zero for TDim

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Eq for TDim