Struct tract_core::dim::TDim

pub struct TDim(_);

An arithmetic expression built with integer and the special value S for the streaming dimension.

Methods

impl TDim

pub fn is_one(&self) -> bool

Is this value One?

pub fn s() -> TDim

The special value S, for streaming.

pub fn stream() -> TDim

The special value S, for streaming.

pub fn as_const(&self) -> Option<i32>

Try to convert the value to an integer, if it does not contains S.

pub fn eval(&self, s: i32) -> Option<i32>

Eval the value for a given value of S.

pub fn is_stream(&self) -> bool

Is the value dependend on S ?

pub fn to_integer(&self) -> TractResult<i32>

Convert to integer if possible.

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

Integer division rounding above.

Trait Implementations

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 IntoExp<GenericFact<TDim>> for TDim

fn bex(self) -> Exp<DimFact>

Converts the value to an Expression.

impl<'_> IntoExp<GenericFact<TDim>> for &'_ TDim

fn bex(self) -> Exp<DimFact>

Converts the value to an Expression.

impl ArrayDatum for TDim

fn stack_views(
    axis: usize,
    views: &[ArrayViewD<TDim>]
) -> TractResult<ArrayD<TDim>>

unsafe fn uninitialized_array<S, D, Sh>(shape: Sh) -> ArrayBase<S, D> where
    Sh: ShapeBuilder<Dim = D>,
    S: DataOwned<Elem = Self>,
    D: Dimension, 

impl Datum for TDim

fn name() -> &'static str

fn datum_type() -> DatumType

impl DimLike for TDim

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

Convert to regular integer.

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

Integer divise, rounding up to next integer.

impl Clone for TDim

fn clone(&self) -> TDim

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TDim

fn default() -> TDim

Returns the "default value" for a type.

impl From<TDim> for Tensor

fn from(it: TDim) -> Tensor

Performs the conversion.

impl From<i64> for TDim

fn from(it: i64) -> TDim

Performs the conversion.

impl From<i32> for TDim

fn from(it: i32) -> TDim

Performs the conversion.

impl From<isize> for TDim

fn from(it: isize) -> TDim

Performs the conversion.

impl From<usize> for TDim

fn from(it: usize) -> TDim

Performs the conversion.

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

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

Performs the conversion.

impl PartialEq<TDim> for TDim

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

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

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

This method tests for !=.

impl Eq for TDim

impl Display for TDim

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

Formats the value using the given formatter.

impl Debug for TDim

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

Formats the value using the given formatter.

impl Div<TDim> for TDim

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<I: AsPrimitive<i32>> Div<I> for TDim

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Add<TDim> for TDim

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<I: AsPrimitive<i32>> Add<I> for TDim

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<TDim> for TDim

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<I: AsPrimitive<i32>> Sub<I> for TDim

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Mul<TDim> for TDim

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<I: AsPrimitive<i32>> Mul<I> for TDim

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Rem<TDim> for TDim

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<I: AsPrimitive<i32>> Rem<I> for TDim

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl Neg for TDim

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl AddAssign<TDim> for TDim

fn add_assign(&mut self, rhs: TDim)

Performs the += operation.

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

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

Performs the += operation.

impl SubAssign<TDim> for TDim

fn sub_assign(&mut self, rhs: TDim)

Performs the -= operation.

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

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

Performs the -= operation.

impl MulAssign<TDim> for TDim

fn mul_assign(&mut self, rhs: TDim)

Performs the *= operation.

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

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

Performs the *= operation.

impl DivAssign<TDim> for TDim

fn div_assign(&mut self, rhs: TDim)

Performs the /= operation.

impl RemAssign<TDim> for TDim

fn rem_assign(&mut self, rhs: TDim)

Performs the %= operation.

impl Product<TDim> for TDim

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

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Sum<TDim> for TDim

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

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

impl FromIterator<TDim> for ShapeFact

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

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.

fn from_str(s: &str) -> Result<TDim, Self::Err>

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

impl Zero for TDim

fn zero() -> Self

Returns the additive identity element of Self, 0. # Purity

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 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<Self>, 

Returns true if self is equal to the multiplicative identity.