Struct tract_hir::infer::ShapeFactoid

pub struct ShapeFactoid { /* fields omitted */ }

Partial information about a shape.

A basic example of a shape fact is shapefactoid![1, 2], which corresponds to the shape [1, 2] in Arc. We can use _ in facts to denote unknown dimensions (e.g. shapefactoid![1, 2, _] corresponds to any shape [1, 2, k] with k a non-negative integer). We can also use .. at the end of a fact to only specify its first dimensions, so shapefactoid![1, 2; ..] matches any shape that starts with [1, 2] (e.g. [1, 2, i] or [1, 2, i, j]), while shapefactoid![..] matches any shape.

Implementations

impl ShapeFactoid

pub fn open(dims: TVec<DimFact>) -> ShapeFactoid

Constructs an open shape fact.

pub fn is_open(&self) -> bool

pub fn closed(dims: TVec<DimFact>) -> ShapeFactoid

Constructs a closed shape fact.

pub fn rank(&self) -> IntFactoid

pub fn ensure_rank_at_least(&mut self, n: usize) -> bool

pub fn dim(&self, i: usize) -> Option<DimFact>

pub fn set_dim(&mut self, i: usize, d: TDim) -> bool

pub fn dims(&self) -> impl Iterator<Item = DimFact>

pub fn stream_info(&self) -> TractResult<Option<StreamFact>>

pub fn as_concrete_finite(&self) -> TractResult<Option<TVec<usize>>>

Trait Implementations

impl Clone for ShapeFactoid

fn clone(&self) -> ShapeFactoid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeFactoid

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

Formats the value using the given formatter.

impl Default for ShapeFactoid

fn default() -> ShapeFactoid

Returns the most general shape fact possible.

impl Factoid for ShapeFactoid

type Concrete = TVec<TDim>

fn concretize(self: &ShapeFactoid) -> Option<TVec<TDim>>

Tries to transform the fact into a Vec<usize>, or returns None.

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

Tries to unify the fact with another fact of the same type.

fn is_concrete(&self) -> bool

Returns whether the value is fully determined.

fn unify_with(&mut self, other: &Self) -> TractResult<bool>

Tries to unify the fact with another fact of the same type and update self.

fn unify_with_mut(&mut self, other: &mut Self) -> TractResult<bool>

Tries to unify the fact with another fact of the same type and update both of them.

fn unify_all(facts: &mut [&mut Self]) -> TractResult<bool>

Tries to unify all facts in the list.

impl<D: ToDim, I: IntoIterator<Item = D>> From<I> for ShapeFactoid

fn from(it: I) -> ShapeFactoid

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 FromIterator<usize> for ShapeFactoid

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

Converts an iterator over usize into a closed shape.

impl Hash for ShapeFactoid

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, 

Feeds a slice of this type into the given [Hasher].

impl IntoExp<ShapeFactoid> for ShapeFactoid

fn bex(self) -> Exp<ShapeFactoid>

Converts the value to an Expression.

impl IntoExp<ShapeFactoid> for ShapeProxy

fn bex(self) -> Exp<ShapeFactoid>

Converts the value to an Expression.

impl<'a> IntoExp<ShapeFactoid> for &'a ShapeProxy

fn bex(self) -> Exp<ShapeFactoid>

Converts the value to an Expression.

impl IntoExp<ShapeFactoid> for TVec<TDim>

fn bex(self) -> Exp<ShapeFactoid>

Converts the value to an Expression.

impl Output for ShapeFactoid

fn into_wrapped(source: Self) -> Wrapped

Wraps the fact in the Wrapped type.

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

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<ShapeFactoid> for ShapeFactoid

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

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

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

This method tests for !=.

impl StructuralPartialEq for ShapeFactoid