Enum tract_hir::prelude::TDim

pub enum TDim {
    Sym(Symbol),
    Val(i64),
    Add(Vec<TDim, Global>),
    Mul(i64, Box<TDim, Global>),
    Div(Box<TDim, Global>, u64),
}

Variants

Sym(Symbol)

Val(i64)

Add(Vec<TDim, Global>)

Mul(i64, Box<TDim, Global>)

Div(Box<TDim, Global>, u64)

Implementations

impl TDim

pub fn is_one(&self) -> bool

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

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

pub fn reduce(self) -> TDim

pub fn simplify(self) -> TDim

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

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

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

Trait Implementations

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

type Output = TDim

The resulting type after applying the + operator.

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

Performs the + operation.

impl<I> Add<I> for TDim where
    I: Into<TDim>, 

type Output = TDim

The resulting type after applying the + operator.

pub fn add(self, rhs: I) -> TDim

Performs the + operation.

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

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

Performs the += operation.

impl<I> AddAssign<I> for TDim where
    I: Into<TDim>, 

pub fn add_assign(&mut self, rhs: I)

Performs the += operation.

impl Clone for TDim

pub fn clone(&self) -> TDim

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Datum for TDim

pub fn name() -> &'static str

pub fn datum_type() -> DatumType

impl Debug for TDim

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

Formats the value using the given formatter.

impl Default for TDim

pub fn default() -> TDim

Returns the “default value” for a type.

impl DimLike for TDim

pub fn maybe_div(&self, other: &TDim) -> Result<(TDim, u64), Error>

pub fn maybe_mul(&self, other: &TDim) -> Result<TDim, Error>

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

Convert to regular integer.

pub fn one() -> TDim

do not use num_traits::Mul as it implies a regular Mul

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

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

Integer divise, rounding up to next integer.

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

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

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

impl Display for TDim

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

Formats the value using the given formatter.

impl<I> Div<I> for TDim where
    I: AsPrimitive<u64>, 

type Output = TDim

The resulting type after applying the / operator.

pub fn div(self, rhs: I) -> TDim

Performs the / operation.

impl<I> DivAssign<I> for TDim where
    I: AsPrimitive<u64>, 

pub fn div_assign(&mut self, rhs: I)

Performs the /= operation.

impl Eq for TDim

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl From<Symbol> for TDim

pub fn from(it: Symbol) -> TDim

Performs the conversion.

impl From<TDim> for Tensor

pub fn from(it: TDim) -> Tensor

Performs the conversion.

impl From<i32> for TDim

pub fn from(v: i32) -> TDim

Performs the conversion.

impl From<i64> for TDim

pub fn from(v: i64) -> TDim

Performs the conversion.

impl From<isize> for TDim

pub fn from(v: isize) -> TDim

Performs the conversion.

impl From<usize> for TDim

pub fn from(v: usize) -> TDim

Performs the conversion.

impl FromIterator<TDim> for ShapeFactoid

fn from_iter<I: IntoIterator<Item = TDim>>(iter: I) -> ShapeFactoid

Converts an iterator over usize into a closed shape.

impl FromStr for TDim

type Err = ParseIntError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<TDim, <TDim as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for TDim

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl IntoExp<GenericFactoid<TDim>> for TDim

fn bex(self) -> Exp<DimFact>

Converts the value to an Expression.

impl IntoExp<GenericFactoid<TDim>> for &TDim

fn bex(self) -> Exp<DimFact>

Converts the value to an Expression.

impl<I> Mul<I> for TDim where
    I: AsPrimitive<i64>, 

type Output = TDim

The resulting type after applying the * operator.

pub fn mul(self, rhs: I) -> TDim

Performs the * operation.

impl MulAssign<i64> for TDim

pub fn mul_assign(&mut self, rhs: i64)

Performs the *= operation.

impl Neg for TDim

type Output = TDim

The resulting type after applying the - operator.

pub fn neg(self) -> TDim

Performs the unary - operation.

impl Ord for TDim

pub fn cmp(&self, other: &TDim) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl Output for TDim

fn into_wrapped(source: TDim) -> Wrapped

Wraps the fact in the Wrapped type.

fn from_wrapped(wrapped: Wrapped) -> TractResult<TDim>

Retrieves the fact from the Wrapped type. Panics if wrapped doesn’t have the right constructor.

fn wrap(self) -> Wrapped

Wraps self in the Wrapped type.

impl PartialEq<TDim> for TDim

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TDim> for TDim

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

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<I> Rem<I> for TDim where
    I: AsPrimitive<u64>, 

type Output = TDim

The resulting type after applying the % operator.

pub fn rem(self, rhs: I) -> TDim

Performs the % operation.

impl<I> RemAssign<I> for TDim where
    I: AsPrimitive<u64>, 

pub fn rem_assign(&mut self, rhs: I)

Performs the %= operation.

impl StructuralEq for TDim

impl StructuralPartialEq for TDim

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

type Output = TDim

The resulting type after applying the - operator.

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

Performs the - operation.

impl<I> Sub<I> for TDim where
    I: Into<TDim>, 

type Output = TDim

The resulting type after applying the - operator.

pub fn sub(self, rhs: I) -> TDim

Performs the - operation.

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

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

Performs the -= operation.

impl<I> SubAssign<I> for TDim where
    I: Into<TDim>, 

pub fn sub_assign(&mut self, rhs: I)

Performs the -= operation.

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

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

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum<TDim> for TDim

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

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<'a> ToDim for &'a TDim

pub 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.

pub fn try_from(d: &'a TDim) -> Result<TDim, Error>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(d: &'a TDim) -> Result<usize, Error>

Performs the conversion.

impl Zero for TDim

pub fn zero() -> TDim

Returns the additive identity element of Self, 0.

pub fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

pub fn set_zero(&mut self)

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