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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
//! Vectors.

use std::num::NonZeroUsize;

use crate::error::Error;
use crate::slice::AsSlice;

pub mod proto;

/// Set of vectors of the same size.
pub trait VectorSet<T> {
    /// Vector type.
    ///
    /// Supposed to be a slice or a Vec.
    type Vector: ?Sized + AsSlice<T>;

    /// Returns the number of vectors in the set.
    fn len(&self) -> usize;

    /// Returns the size of each vector.
    fn vector_size(&self) -> usize;

    /// Returns the i-th vector.
    fn get(&self, i: usize) -> &Self::Vector;
}

/// Vectors in a contiguous array.
#[derive(Clone, Debug)]
pub struct BlockVectorSet<T> {
    data: Vec<T>,

    /// Vector size.
    pub vector_size: usize,
}

impl<T> BlockVectorSet<T> {
    /// Tries to chunk a given `Vec`.
    ///
    /// Fails if `data.len` is not a multiple of `vector_size`.
    pub fn chunk(
        data: Vec<T>,
        vector_size: NonZeroUsize,
    ) -> Result<Self, Error> {
        let m = vector_size.get();
        if data.is_empty() || data.len() % m == 0 {
            Ok(Self {
                data,
                vector_size: m,
            })
        } else {
            Err(Error::InvalidArgs(format!(
                "data size ({}) is not a multiple of vector size ({})",
                data.len(),
                vector_size,
            )))
        }
    }

    /// Returns the number of vectors in the vector set.
    pub fn len(&self) -> usize {
        self.data.len() / self.vector_size
    }

    /// Returns the size of each vector in the vector set.
    pub const fn vector_size(&self) -> usize {
        self.vector_size
    }

    /// Returns the i-th vector in the vector set.
    ///
    /// Panics if `i` is out of bounds.
    pub fn get(&self, i: usize) -> &[T] {
        let from = i * self.vector_size;
        let to = from + self.vector_size;
        &self.data[from..to]
    }

    /// Returns the mutable i-th vector.
    pub fn get_mut(&mut self, i: usize) -> &mut [T] {
        let from = i * self.vector_size;
        let to = from + self.vector_size;
        &mut self.data[from..to]
    }
}

impl<T> VectorSet<T> for BlockVectorSet<T> {
    type Vector = [T];

    fn len(&self) -> usize {
        self.len()
    }

    fn vector_size(&self) -> usize {
        self.vector_size()
    }

    fn get(&self, i: usize) -> &Self::Vector {
        self.get(i)
    }
}

/// Subvectors of another vector set.
pub struct SubVectorSet<'a, T, VS>
where
    VS: VectorSet<T>,
{
    // Underlying vector set.
    vs: &'a VS,
    // Length of a subvector.
    vector_size: usize,
    // Offset to the first subvector.
    offset: usize,
    t: std::marker::PhantomData<T>,
}

impl<'a, T, VS> SubVectorSet<'a, T, VS>
where
    VS: VectorSet<T>,
{
    /// Creates a [`SubVectorSet`] of a given [`VectorSet`].
    pub fn new(vs: &'a VS, vector_size: usize, offset: usize) -> Self {
        Self {
            vs,
            vector_size,
            offset,
            t: std::marker::PhantomData,
        }
    }
}

impl<'a, T, VS> VectorSet<T> for SubVectorSet<'a, T, VS>
where
    VS: VectorSet<T>,
{
    type Vector = [T];

    fn len(&self) -> usize {
        self.vs.len()
    }

    fn vector_size(&self) -> usize {
        self.vector_size
    }

    fn get(&self, i: usize) -> &Self::Vector {
        let v = self.vs.get(i).as_slice();
        &v[self.offset..self.offset + self.vector_size]
    }
}

/// Divides a given vector set into subvector sets.
///
/// Fails if `vs.vector_size()` is not multiple of `d`.
pub fn divide_vector_set<'a, T, VS>(
    vs: &'a VS,
    d: NonZeroUsize,
) -> Result<Vec<SubVectorSet<'a, T, VS>>, Error>
where
    VS: VectorSet<T>,
{
    let d = d.get();
    if vs.vector_size() % d != 0 {
        return Err(Error::InvalidArgs(format!(
            "vector size ({}) is not divisible by {}",
            vs.vector_size(),
            d,
        )));
    }
    let m = vs.vector_size() / d;
    let divided = (0..d)
        .map(|i| SubVectorSet::new(vs, m, i * m))
        .collect();
    Ok(divided)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn block_vector_set_can_chunk_10_elements_into_5_vectors_of_2_elements() {
        let v: Vec<f32> = vec![
            1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0,
        ];
        let vs = BlockVectorSet::chunk(v, 2.try_into().unwrap()).unwrap();
        assert_eq!(vs.vector_size(), 2);
        assert_eq!(vs.len(), 5);
        assert_eq!(vs.get(0), &[1.0, 2.0]);
        assert_eq!(vs.get(1), &[3.0, 4.0]);
        assert_eq!(vs.get(2), &[5.0, 6.0]);
        assert_eq!(vs.get(3), &[7.0, 8.0]);
        assert_eq!(vs.get(4), &[9.0, 10.0]);
    }

    #[test]
    fn block_vector_set_can_chunk_empty_vec() {
        let vs = BlockVectorSet::chunk(
            Vec::<f32>::new(),
            10.try_into().unwrap(),
        ).unwrap();
        assert_eq!(vs.vector_size(), 10);
        assert_eq!(vs.len(), 0);
    }

    #[test]
    fn block_vector_set_cannot_chunk_10_elements_by_vectors_of_3_elements() {
        let v: Vec<f32> = vec![
            1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0,
        ];
        assert!(BlockVectorSet::chunk(v, 3.try_into().unwrap()).is_err())
    }

    #[test]
    fn divide_vector_set_can_divide_5_vectors_of_6_elements_by_2() {
        let v: Vec<f32> = vec![
            1.0, 2.0, 3.0, 4.0, 5.0, 6.0,
            7.0, 8.0, 9.0, 10.0, 11.0, 12.0,
            13.0, 14.0, 15.0, 16.0, 17.0, 18.0,
            19.0, 20.0, 21.0, 22.0, 23.0, 24.0,
            25.0, 26.0, 27.0, 28.0, 29.0, 30.0,
        ];
        let vs = BlockVectorSet::chunk(v, 6.try_into().unwrap()).unwrap();
        let divided = divide_vector_set(&vs, 2.try_into().unwrap()).unwrap();
        assert_eq!(divided.len(), 2);
        assert_eq!(divided[0].vector_size(), 3);
        assert_eq!(divided[0].len(), 5);
        assert_eq!(divided[0].get(0), &[1.0, 2.0, 3.0]);
        assert_eq!(divided[0].get(1), &[7.0, 8.0, 9.0]);
        assert_eq!(divided[0].get(2), &[13.0, 14.0, 15.0]);
        assert_eq!(divided[0].get(3), &[19.0, 20.0, 21.0]);
        assert_eq!(divided[0].get(4), &[25.0, 26.0, 27.0]);
        assert_eq!(divided[1].vector_size(), 3);
        assert_eq!(divided[1].len(), 5);
        assert_eq!(divided[1].get(0), &[4.0, 5.0, 6.0]);
        assert_eq!(divided[1].get(1), &[10.0, 11.0, 12.0]);
        assert_eq!(divided[1].get(2), &[16.0, 17.0, 18.0]);
        assert_eq!(divided[1].get(3), &[22.0, 23.0, 24.0]);
        assert_eq!(divided[1].get(4), &[28.0, 29.0, 30.0]);
    }

    #[test]
    fn divide_vector_set_can_divide_empty_vector_set() {
        let vs = BlockVectorSet::chunk(
            Vec::<f32>::new(),
            10.try_into().unwrap(),
        ).unwrap();
        let divided = divide_vector_set(&vs, 2.try_into().unwrap()).unwrap();
        assert_eq!(divided.len(), 2);
        assert_eq!(divided[0].vector_size(), 5);
        assert_eq!(divided[0].len(), 0);
        assert_eq!(divided[1].vector_size(), 5);
        assert_eq!(divided[1].len(), 0);
    }

    #[test]
    fn divide_vector_set_cannot_divide_5_vectors_of_4_elements_by_3() {
        let v: Vec<f32> = vec![
            1.0, 2.0, 3.0, 4.0,
            5.0, 6.0, 7.0, 8.0,
            9.0, 10.0, 11.0, 12.0,
            13.0, 14.0, 15.0, 16.0,
            17.0, 18.0, 19.0, 20.0,
        ];
        let vs = BlockVectorSet::chunk(v, 4.try_into().unwrap()).unwrap();
        assert!(divide_vector_set(&vs, 3.try_into().unwrap()).is_err());
    }
}