Struct BoundedVl 

pub struct BoundedVl<Hart>(/* private fields */)
where
    Hart: VectorHartConfig;

Vector length of a VectorConfig, which never exceeds VLEN.

vl <= VLMAX = LMUL * VLEN / SEW <= VLEN, since LMUL <= 8 and SEW >= 8. Constructors enforce the bound, so unsafe code can rely on it for accessing a single vector register, like mask registers with one bit per element.

Implementations

impl<Hart> BoundedVl<Hart>

where Hart: VectorHartConfig,

pub const fn new(vl: Vl) -> Option<Self>

Create a new instance, returns None if vl exceeds VLEN

pub const fn get(self) -> Vl

Vector length, which is <= VLEN

pub fn indices(self) -> impl Iterator<Item = u16>

Element indices 0..vl.

Unlike a range of u16, which can’t represent vl = 65536 as an exclusive bound, this lets the compiler see that every index is below vl and VLEN.

pub const fn bytes(self) -> u16

Vector length in bytes, ceil(vl / 8), which is <= VLEN.bytes()

Trait Implementations

impl<Hart> Clone for BoundedVl<Hart>

where Hart: VectorHartConfig + Clone,

fn clone(&self) -> BoundedVl<Hart>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Hart> Copy for BoundedVl<Hart>

where Hart: VectorHartConfig + Copy,

impl<Hart> Debug for BoundedVl<Hart>

where Hart: VectorHartConfig + Debug,

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

Formats the value using the given formatter.

impl<Hart> Display for BoundedVl<Hart>

where Hart: VectorHartConfig,

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

Formats the value using the given formatter.

impl<Hart> Eq for BoundedVl<Hart>

where Hart: VectorHartConfig,

impl<Hart> From<BoundedVl<Hart>> for Vl

where Hart: VectorHartConfig,

fn from(value: BoundedVl<Hart>) -> Self

Converts to this type from the input type.

impl<Hart> PartialEq for BoundedVl<Hart>

where Hart: VectorHartConfig,

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

Equality operator ==.

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

Inequality operator !=.