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>),
}

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

Implementations

impl TDim

pub fn is_one(&self) -> bool

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

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

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

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

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

pub fn substitute(&self, from: &Symbol, to: &TDim) -> Result<TDim, Error>

pub fn reduce(self) -> TDim

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

pub fn simplify(self) -> 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 gcd(&self) -> u64

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

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) -> TDim

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) -> TDim

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() -> TDim

Returns the smallest finite number this type can represent

fn max_value() -> TDim

Returns the largest finite number this type can represent

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 CoerceFrom<Value> for TDim

fn coerce(builder: &mut ModelBuilder<'_>, from: &Value) -> Result<TDim, Error>

impl Datum for TDim

fn name() -> &'static str

fn datum_type() -> DatumType

fn is<D>() -> bool

where D: Datum,

impl Debug for TDim

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

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: &TDim) -> Result<(TDim, u64), Error>

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

Convert to regular integer.

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

Substitute as many symbols as possible in the dim value.

fn substitute(&self, from: &Symbol, to: &TDim) -> Result<TDim, Error>

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

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

fn broadcast(self, other: TDim) -> Result<TDim, Error>

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

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

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

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

Integer divise, rounding up to next integer.

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

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

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

impl Display for TDim

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> + PrimInt,

type Output = TDim

The resulting type after applying the / operator.

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

Performs the / operation.

impl<I> DivAssign<I> for TDim

where I: AsPrimitive<u64> + PrimInt,

fn div_assign(&mut self, rhs: I)

Performs the /= operation.

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

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

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) -> TDim

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>(&self, state: &mut __H)

where __H: Hasher,

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) -> TDim

Performs the * operation.

impl<I> Mul<I> for TDim

where I: Into<TDim>,

type Output = TDim

The resulting type after applying the * operator.

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

Performs the * operation.

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

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

Performs the *= operation.

impl<I> MulAssign<I> for TDim

where I: Into<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) -> TDim

Performs the unary - operation.

impl One for TDim

fn one() -> TDim

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: &TDim) -> 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>(iter: I) -> TDim

where I: Iterator<Item = &'a TDim>,

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

impl Product for TDim

fn product<I>(iter: I) -> TDim

where I: Iterator<Item = TDim>,

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

impl<I> Rem<I> for TDim

where I: AsPrimitive<u64> + PrimInt,

type Output = TDim

The resulting type after applying the % operator.

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

Performs the % operation.

impl<I> RemAssign<I> for TDim

where I: AsPrimitive<u64> + PrimInt,

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) -> TDim

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) -> TDim

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>(iter: I) -> TDim

where I: Iterator<Item = &'a TDim>,

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

impl Sum for TDim

fn sum<I>(iter: I) -> TDim

where I: Iterator<Item = 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) -> 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.

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

Performs the conversion.

impl Zero for TDim

fn zero() -> TDim

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

impl StructuralPartialEq for TDim