Struct AxisMask 

pub struct AxisMask(/* private fields */);

A bitmask over the design-cube axes. Bit i set means the corresponding axis is engaged at its non-default value.

The direction signature for a variant is its AxisMask: which axes it sets to non-default values. A workload’s required signature is also an AxisMask: which axes it needs the transport (or pointer type) to handle non-trivially.

Implementations

impl AxisMask

pub const EMPTY: AxisMask

The empty signature (no axes engaged). Corresponds to the origin corner of the cube (Chase-Lev’s signature).

pub const ALL: AxisMask

All defined axes engaged.

pub const fn from_axes(axes: &[Axis]) -> Self

Build a signature from a slice of engaged axes.

pub const fn from_bits(bits: u16) -> Self

Build from a raw u16. Bits outside the valid range are masked off.

pub const fn bits(self) -> u16

Return the raw u16 representation.

pub const fn contains(self, a: Axis) -> bool

true if axis a is engaged in this signature.

pub const fn count(self) -> u32

Count of engaged axes (popcount of the bitmask).

pub const fn union(self, other: AxisMask) -> AxisMask

Union of two signatures.

pub const fn intersection(self, other: AxisMask) -> AxisMask

Intersection of two signatures.

pub const fn satisfies(self, other: AxisMask) -> bool

true if this signature is a superset of other (i.e. every axis required by other is engaged in self).

provided.satisfies(required) means the variant provided can transport the workload required.

pub const fn distance(self, other: AxisMask) -> u32

Hamming distance between two signatures: how many axes differ. This is the cube-distance the dispatcher pays when routing a workload to a non-perfect-match variant.

Trait Implementations

impl Clone for AxisMask

fn clone(&self) -> AxisMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AxisMask

impl Debug for AxisMask

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

Formats the value using the given formatter.

impl Display for AxisMask

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

Formats the value using the given formatter.

impl Eq for AxisMask

impl Hash for AxisMask

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

Feeds a slice of this type into the given Hasher.

impl PartialEq for AxisMask

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AxisMask