Skip to main content

ShapePredicate

Enum ShapePredicate 

Source
#[non_exhaustive]
pub enum ShapePredicate { AtLeast(u32), AtMost(u32), Exactly(u32), MultipleOf(u32), ModEquals { modulus: u32, remainder: u32, }, AffineRange { scale: i64, offset: i64, min: i64, max: i64, }, And(Box<ShapePredicate>, Box<ShapePredicate>), Or(Box<ShapePredicate>, Box<ShapePredicate>), Not(Box<ShapePredicate>), }
Expand description

Refinement predicate over a buffer’s element count (P-1.0-V3.1).

Represents a small grammar of constraints a BufferDecl author can attach. The validator (P-1.0-V3.2) checks each predicate against the program’s static count and the optimizer (P-1.0-V3.3) uses verified predicates to prove loop-bound and alignment invariants for vectorization.

None (the default) is “unconstrained”; existing programs keep their current behavior.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

AtLeast(u32)

count >= n. Holds when the runtime element count is at least n. Used to prove non-empty workgroup buffers and minimum vectorization tile sizes.

§

AtMost(u32)

count <= n. Holds when the count never exceeds n. Used to bound dispatch sizes and prevent oversized allocations.

§

Exactly(u32)

count == n. The strongest constraint; the count is fixed.

§

MultipleOf(u32)

count % n == 0. Used for alignment proofs (e.g. SIMD lanes).

§

ModEquals

count % modulus == remainder. Invalid modular forms evaluate false, so static validation catches impossible declarations.

Fields

§modulus: u32

Divisor used by the modular equality.

§remainder: u32

Required remainder. Must be less than modulus to match.

§

AffineRange

min <= count * scale + offset <= max, evaluated with wide arithmetic for frontend-derived affine constraints.

Fields

§scale: i64

Multiplicative coefficient applied to count.

§offset: i64

Constant term added after scaling.

§min: i64

Inclusive lower bound for the affine expression.

§max: i64

Inclusive upper bound for the affine expression.

§

And(Box<ShapePredicate>, Box<ShapePredicate>)

Conjunction of two predicates (p1 && p2). Both must hold.

§

Or(Box<ShapePredicate>, Box<ShapePredicate>)

Disjunction of two predicates (p1 || p2). Either may hold.

§

Not(Box<ShapePredicate>)

Negation of a predicate.

Implementations§

Source§

impl ShapePredicate

Source

pub fn holds(&self, count: u32) -> bool

Evaluate the predicate against a concrete count. Returns true when the predicate holds. P-1.0-V3.2 uses this from the validate() pass; P-1.0-V3.3 calls it from optimizer passes that need a yes/no proof.

Source

pub fn evaluate(&self, count: u32) -> bool

Evaluate the predicate against a concrete count.

Source

pub fn proves_non_empty(&self) -> bool

Whether this predicate proves that the count cannot be zero.

Source

pub fn describe(&self) -> String

Human-readable form for error messages.

Trait Implementations§

Source§

impl Clone for ShapePredicate

Source§

fn clone(&self) -> ShapePredicate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ShapePredicate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ShapePredicate

Source§

impl Hash for ShapePredicate

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ShapePredicate

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ShapePredicate

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more