Struct machine_check::BitvectorArray

pub struct BitvectorArray<const I: u32, const L: u32> { /* private fields */ }

Power-of-two array of bitvectors without signedness information.

The exponent of array size is specified in the first generic parameter I. Element length is specified in the second generic parameter L.

The array is indexed by bitvectors of length I, so no out-of-bound access can occur.

Implementations

impl<const I: u32, const L: u32> BitvectorArray<I, L>

pub fn new_filled(element: Bitvector<L>) -> Self

Creates a new array filled with the given element.

Examples found in repository

examples/simple_risc.rs (line 140)

fn main() {
    let toy_program = [
        // (0) set r0 to zero
        Bitvector::new(0b0100_0000_0000),
        // (1) set r1 to one
        Bitvector::new(0b0101_0000_0001),
        // (2) set r2 to zero
        Bitvector::new(0b0110_0000_0000),
        // --- main loop ---
        // (3) store r1 content to data location 0
        Bitvector::new(0b1100_0000_0000),
        // (4) store r2 content to data location 1
        Bitvector::new(0b1100_0000_0001),
        // (5) read input location 0 to r3
        Bitvector::new(0b0011_0100_0000),
        // (6) jump to (3) if r3 bit 0 is set
        Bitvector::new(0b0011_1000_0011),
        // (7) increment r2
        Bitvector::new(0b0010_0000_1001),
        // (8) store r2 content to data location 1
        Bitvector::new(0b1110_0000_0001),
        // (9) jump to (3)
        Bitvector::new(0b0001_1000_0011),
    ];

    // load toy program to program memory, filling unused locations with 0
    let mut progmem = BitvectorArray::new_filled(Bitvector::new(0));
    for (index, instruction) in toy_program.into_iter().enumerate() {
        progmem[Bitvector::new(index as u64)] = instruction;
    }
    let system = machine_module::System { progmem };
    machine_check::run(system);
}

pub fn from_slice(slice: &[Bitvector<L>]) -> Self

Creates the bitvector array from a correctly sized slice of bitvectors.

Panics if the bitvector slice length is not equal to 2^L.

Cannot be used within the machine_description macro.

Trait Implementations

impl<const I: u32, const L: u32> Clone for BitvectorArray<I, L>

fn clone(&self) -> BitvectorArray<I, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const I: u32, const L: u32> Debug for BitvectorArray<I, L>

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

Formats the value using the given formatter.

impl<const I: u32, const L: u32> Hash for BitvectorArray<I, L>

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<const I: u32, const L: u32> Index<Bitvector<I>> for BitvectorArray<I, L>

type Output = Bitvector<L>

The returned type after indexing.

fn index(&self, index: Bitvector<I>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const I: u32, const L: u32> IndexMut<Bitvector<I>> for BitvectorArray<I, L>

fn index_mut(&mut self, index: Bitvector<I>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const I: u32, const L: u32> IntoMck for BitvectorArray<I, L>

type Type = Array<I, L>

fn into_mck(self) -> Self::Type

impl<const I: u32, const L: u32> PartialEq for BitvectorArray<I, L>

fn eq(&self, other: &BitvectorArray<I, L>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const I: u32, const L: u32> Eq for BitvectorArray<I, L>

impl<const I: u32, const L: u32> StructuralPartialEq for BitvectorArray<I, L>