scale_std 0.1.2

datastructures and algorithms to be run on the SCALE engine
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

// Copyright (c) 2021, COSIC-KU Leuven, Kasteelpark Arenberg 10, bus 2452, B-3001 Leuven-Heverlee, Belgium.
// Copyright (c) 2021, Cosmian Tech SAS, 53-55 rue La Boétie, Paris, France.

use crate::array::Array;
use scale::alloc::GetAllocator;
use scale::{alloc::Allocate, LoadFromMem, Reveal, Stack, StackAddress, StoreInMem};

/// An matrix datastructure that allocates memory and never frees it
pub struct Matrix<T, const N: u64, const M: u64> {
    // Act like we are a matrix
    phantom: core::marker::PhantomData<T>,
    // Base address of the matrix in memory
    base_address: u64,
}

impl<T: GetAllocator + StoreInMem<i64>, const N: u64, const M: u64> Matrix<T, N, M> {
    #[inline(always)]
    pub fn fill(t: T) -> Self {
        let mut matrix = Self::uninitialized();
        for i in 0..(N * M) {
            matrix.set_mem(i, &t);
        }
        matrix
    }

    #[inline(always)]
    pub fn uninitialized() -> Self {
        Self {
            phantom: core::marker::PhantomData,
            base_address: T::get_allocator().allocate(N * M),
        }
    }
}

impl<T: LoadFromMem<i64> + GetAllocator + StoreInMem<i64>, const N: u64, const M: u64>
    Matrix<T, N, M>
{
    #[inline(always)]
    pub fn iter(&self) -> impl Iterator<Item = T> + '_ {
        (0..(N * M)).map(move |i| self.get_mem(i))
    }
    #[inline(always)]
    pub fn get(&self, i: u64, j: u64) -> T {
        T::load_from_mem((self.base_address + i * M + j) as _)
    }

    /* This version just indexes according to the 'standard' ordering */
    #[inline(always)]
    pub fn get_mem(&self, i: u64) -> T {
        T::load_from_mem((self.base_address + i) as _)
    }

    #[inline(always)]
    pub fn get_row(&self, i: u64) -> Array<T, M> {
        Array::from_iter((0..M).map(|j| T::load_from_mem((self.base_address + i * M + j) as _)))
    }
    #[inline(always)]
    pub fn get_column(&self, j: u64) -> Array<T, N> {
        Array::from_iter((0..N).map(|i| T::load_from_mem((self.base_address + i * M + j) as _)))
    }
}

impl<T: StoreInMem<i64>, const N: u64, const M: u64> Matrix<T, N, M> {
    #[inline(always)]
    pub fn set(&mut self, i: u64, j: u64, val: &T) {
        unsafe { val.store_in_mem((self.base_address + i * M + j) as _) }
    }

    /* This version just indexes according to the 'standard' ordering */
    #[inline(always)]
    pub fn set_mem(&mut self, i: u64, val: &T) {
        unsafe { val.store_in_mem((self.base_address + i) as _) }
    }
}

impl<
        T: LoadFromMem<i64> + StoreInMem<i64> + GetAllocator + Stack + Reveal,
        const N: u64,
        const M: u64,
    > Reveal for Matrix<T, N, M>
where
    <T as Reveal>::Output: GetAllocator + StoreInMem<i64>,
{
    type Output = Matrix<<T as Reveal>::Output, N, M>;
    #[inline(always)]
    fn reveal(&self) -> Self::Output {
        let mut matrix = Self::Output::uninitialized();
        for (i, val) in self.iter().enumerate() {
            matrix.set_mem(i as u64, &val.reveal());
        }
        matrix
    }
}

impl<T: GetAllocator + StoreInMem<i64> + LoadFromMem<i64> + Stack, const N: u64, const M: u64> Stack
    for Matrix<T, N, M>
{
    #[inline(always)]
    unsafe fn push(matrix: &Self) {
        for val in matrix.iter() {
            T::push(&val);
        }
    }
    #[inline(always)]
    unsafe fn pop() -> Self {
        let mut matrix = Self::uninitialized();
        for i in (0..(N * M)).rev() {
            matrix.set_mem(i, &T::pop())
        }
        matrix
    }

    #[inline(always)]
    unsafe fn peek(addr: StackAddress) -> Self {
        let mut matrix = Self::uninitialized();
        for i in 0..(N * M) {
            matrix.set_mem(i, &T::peek(addr + i as _));
        }
        matrix
    }

    #[inline(always)]
    unsafe fn poke(addr: StackAddress, matrix: &Self) {
        for (i, val) in matrix.iter().enumerate() {
            T::poke(addr + i as _, &val);
        }
    }

    #[inline(always)]
    unsafe fn peek_from_top(offset: i64) -> Self {
        let mut matrix = Self::uninitialized();
        for i in 0..(N * M) {
            matrix.set_mem(i, &T::peek_from_top(offset + i as i64));
        }
        matrix
    }

    #[inline(always)]
    unsafe fn poke_from_top(offset: i64, matrix: &Self) {
        for (i, val) in matrix.iter().enumerate() {
            T::poke_from_top(offset + i as i64, &val);
        }
    }

    #[inline(always)]
    fn get_stack_pointer() -> StackAddress {
        unimplemented!("this operation makes no sense");
    }
}