nnl 0.1.6

A high-performance neural network library for Rust with CPU and GPU support
Documentation
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
//! Tensor view module for memory-efficient operations
//!
//! This module provides views into tensor data that allow for operations
//! without copying the underlying data, enabling efficient slicing,
//! indexing, and sub-tensor operations.

use crate::error::{NnlError, Result};
use crate::tensor::Tensor;
use std::ops::{Index, Range};

/// A view into a tensor's data
#[derive(Debug, Clone)]
pub struct TensorView<'a> {
    tensor: &'a Tensor,
    data: Vec<f32>,
    offset: usize,
    shape: Vec<usize>,
    strides: Vec<usize>,
}

impl<'a> TensorView<'a> {
    /// Create a new tensor view
    pub fn new(tensor: &'a Tensor) -> Self {
        let shape = tensor.shape().to_vec();
        let strides = compute_strides(&shape);
        let data = tensor.to_vec().unwrap_or_default();

        Self {
            tensor,
            data,
            offset: 0,
            shape,
            strides,
        }
    }

    /// Create a view with custom offset, shape, and strides
    pub fn new_with_params(
        tensor: &'a Tensor,
        offset: usize,
        shape: Vec<usize>,
        strides: Vec<usize>,
    ) -> Result<Self> {
        if shape.len() != strides.len() {
            return Err(NnlError::tensor(
                "Shape and strides must have the same length",
            ));
        }

        // Validate that the view doesn't exceed tensor bounds
        let max_index = if shape.is_empty() {
            0
        } else {
            offset
                + shape
                    .iter()
                    .zip(strides.iter())
                    .map(|(&dim, &stride)| (dim.saturating_sub(1)) * stride)
                    .max()
                    .unwrap_or(0)
        };

        if max_index >= tensor.size() {
            return Err(NnlError::tensor("View exceeds tensor bounds"));
        }

        let data = tensor.to_vec().unwrap_or_default();

        Ok(Self {
            tensor,
            data,
            offset,
            shape,
            strides,
        })
    }

    /// Get the shape of this view
    pub fn shape(&self) -> &[usize] {
        &self.shape
    }

    /// Get the strides of this view
    pub fn strides(&self) -> &[usize] {
        &self.strides
    }

    /// Get the offset of this view
    pub fn offset(&self) -> usize {
        self.offset
    }

    /// Get the number of dimensions
    pub fn ndim(&self) -> usize {
        self.shape.len()
    }

    /// Get the total number of elements in this view
    pub fn size(&self) -> usize {
        self.shape.iter().product()
    }

    /// Get the underlying tensor
    pub fn tensor(&self) -> &Tensor {
        self.tensor
    }

    /// Check if this view is contiguous in memory
    pub fn is_contiguous(&self) -> bool {
        if self.shape.is_empty() {
            return true;
        }

        let expected_strides = compute_strides(&self.shape);
        self.strides == expected_strides
    }

    /// Create a slice of this view along a specific dimension
    pub fn slice(&self, dim: usize, range: Range<usize>) -> Result<TensorView<'a>> {
        if dim >= self.ndim() {
            return Err(NnlError::tensor("Dimension index out of bounds"));
        }

        if range.end > self.shape[dim] {
            return Err(NnlError::tensor("Slice range exceeds dimension size"));
        }

        let mut new_shape = self.shape.clone();
        new_shape[dim] = range.end - range.start;

        let new_offset = self.offset + range.start * self.strides[dim];

        Self::new_with_params(self.tensor, new_offset, new_shape, self.strides.clone())
    }

    /// Create a view of a specific index along a dimension (reduces dimensionality by 1)
    pub fn select(&self, dim: usize, index: usize) -> Result<TensorView<'a>> {
        if dim >= self.ndim() {
            return Err(NnlError::tensor("Dimension index out of bounds"));
        }

        if index >= self.shape[dim] {
            return Err(NnlError::tensor("Index exceeds dimension size"));
        }

        let mut new_shape = self.shape.clone();
        let mut new_strides = self.strides.clone();

        new_shape.remove(dim);
        new_strides.remove(dim);

        let new_offset = self.offset + index * self.strides[dim];

        Self::new_with_params(self.tensor, new_offset, new_shape, new_strides)
    }

    /// Transpose the view (swap last two dimensions)
    pub fn transpose(&self) -> Result<TensorView<'a>> {
        if self.ndim() < 2 {
            return Err(NnlError::tensor(
                "Cannot transpose view with less than 2 dimensions",
            ));
        }

        let mut new_shape = self.shape.clone();
        let mut new_strides = self.strides.clone();

        let last_idx = new_shape.len() - 1;
        new_shape.swap(last_idx - 1, last_idx);
        new_strides.swap(last_idx - 1, last_idx);

        Self::new_with_params(self.tensor, self.offset, new_shape, new_strides)
    }

    /// Reshape the view (only works if contiguous)
    pub fn reshape(&self, new_shape: &[usize]) -> Result<TensorView<'a>> {
        let new_size = new_shape.iter().product::<usize>();
        if new_size != self.size() {
            return Err(NnlError::shape_mismatch(&[self.size()], &[new_size]));
        }

        if !self.is_contiguous() {
            return Err(NnlError::tensor("Cannot reshape non-contiguous view"));
        }

        let new_strides = compute_strides(new_shape);
        Self::new_with_params(self.tensor, self.offset, new_shape.to_vec(), new_strides)
    }

    /// Create a view with squeezed dimensions (remove dimensions of size 1)
    pub fn squeeze(&self) -> TensorView<'a> {
        let new_shape: Vec<usize> = self
            .shape
            .iter()
            .filter(|&&dim| dim != 1)
            .copied()
            .collect();
        let new_strides: Vec<usize> = self
            .shape
            .iter()
            .zip(self.strides.iter())
            .filter(|&(&dim, _)| dim != 1)
            .map(|(_, &stride)| stride)
            .collect();

        Self {
            tensor: self.tensor,
            data: self.data.clone(),
            offset: self.offset,
            shape: new_shape,
            strides: new_strides,
        }
    }

    /// Create a view with an added dimension of size 1
    pub fn unsqueeze(&self, dim: usize) -> Result<TensorView<'a>> {
        if dim > self.ndim() {
            return Err(NnlError::tensor("Dimension index out of bounds"));
        }

        let mut new_shape = self.shape.clone();
        let mut new_strides = self.strides.clone();

        new_shape.insert(dim, 1);
        new_strides.insert(
            dim,
            if dim == 0 || self.strides.is_empty() {
                self.strides.first().copied().unwrap_or(1)
            } else {
                self.strides[dim - 1]
            },
        );

        Self::new_with_params(self.tensor, self.offset, new_shape, new_strides)
    }

    /// Convert linear index to multi-dimensional indices
    pub fn unravel_index(&self, index: usize) -> Result<Vec<usize>> {
        if index >= self.size() {
            return Err(NnlError::tensor("Index out of bounds"));
        }

        let mut indices = vec![0; self.ndim()];
        let mut remaining = index;

        for (i, &dim_size) in self.shape.iter().enumerate() {
            indices[i] = remaining % dim_size;
            remaining /= dim_size;
        }

        Ok(indices)
    }

    /// Convert multi-dimensional indices to linear index in the view
    pub fn ravel_index(&self, indices: &[usize]) -> Result<usize> {
        if indices.len() != self.ndim() {
            return Err(NnlError::tensor(
                "Number of indices must match tensor dimensions",
            ));
        }

        for (i, (&idx, &dim_size)) in indices.iter().zip(self.shape.iter()).enumerate() {
            if idx >= dim_size {
                return Err(NnlError::tensor(format!(
                    "Index {} out of bounds for dimension {} (size {})",
                    idx, i, dim_size
                )));
            }
        }

        let linear_index = indices
            .iter()
            .zip(self.strides.iter())
            .map(|(&idx, &stride)| idx * stride)
            .sum::<usize>();

        Ok(self.offset + linear_index)
    }

    /// Get a scalar value at the given indices
    pub fn get(&self, indices: &[usize]) -> Result<f32> {
        let tensor_index = self.ravel_index(indices)?;
        let tensor_data = self.tensor.to_vec()?;

        if tensor_index >= tensor_data.len() {
            return Err(NnlError::tensor("Computed index exceeds tensor size"));
        }

        Ok(tensor_data[tensor_index])
    }

    /// Convert view to a new tensor (copies data)
    pub fn to_tensor(&self) -> Result<Tensor> {
        if self.is_contiguous() {
            // For contiguous views, we can copy a slice directly
            let tensor_data = self.tensor.to_vec()?;
            let start = self.offset;
            let end = start + self.size();

            if end > tensor_data.len() {
                return Err(NnlError::tensor("View exceeds tensor bounds"));
            }

            Tensor::from_slice_on_device(
                &tensor_data[start..end],
                &self.shape,
                self.tensor.device().clone(),
            )
        } else {
            // For non-contiguous views, we need to copy element by element
            let mut data = Vec::with_capacity(self.size());
            let tensor_data = self.tensor.to_vec()?;

            for i in 0..self.size() {
                let indices = self.unravel_index(i)?;
                let tensor_index = self.ravel_index(&indices)?;
                data.push(tensor_data[tensor_index]);
            }

            Tensor::from_slice_on_device(&data, &self.shape, self.tensor.device().clone())
        }
    }

    /// Iterate over all elements in the view
    pub fn iter(&'a self) -> TensorViewIterator<'a> {
        TensorViewIterator {
            view: self,
            current_index: 0,
        }
    }

    /// Create a view that iterates along a specific axis
    pub fn axis_iter(&'a self, axis: usize) -> Result<AxisIterator<'a>> {
        if axis >= self.ndim() {
            return Err(NnlError::tensor("Axis index out of bounds"));
        }

        Ok(AxisIterator {
            view: self,
            axis,
            current_index: 0,
        })
    }
}

/// Iterator over tensor view elements
pub struct TensorViewIterator<'a> {
    view: &'a TensorView<'a>,
    current_index: usize,
}

impl<'a> Iterator for TensorViewIterator<'a> {
    type Item = Result<f32>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.current_index >= self.view.size() {
            return None;
        }

        let result = self
            .view
            .unravel_index(self.current_index)
            .and_then(|indices| self.view.get(&indices));

        self.current_index += 1;
        Some(result)
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let remaining = self.view.size() - self.current_index;
        (remaining, Some(remaining))
    }
}

impl<'a> ExactSizeIterator for TensorViewIterator<'a> {}

/// Iterator over views along a specific axis
pub struct AxisIterator<'a> {
    view: &'a TensorView<'a>,
    axis: usize,
    current_index: usize,
}

impl<'a> Iterator for AxisIterator<'a> {
    type Item = Result<TensorView<'a>>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.current_index >= self.view.shape[self.axis] {
            return None;
        }

        let result = self.view.select(self.axis, self.current_index);
        self.current_index += 1;
        Some(result)
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let remaining = self.view.shape[self.axis] - self.current_index;
        (remaining, Some(remaining))
    }
}

impl<'a> ExactSizeIterator for AxisIterator<'a> {}

/// Compute strides for a given shape (row-major order)
fn compute_strides(shape: &[usize]) -> Vec<usize> {
    if shape.is_empty() {
        return Vec::new();
    }

    let mut strides = vec![1; shape.len()];
    for i in (0..shape.len() - 1).rev() {
        strides[i] = strides[i + 1] * shape[i + 1];
    }
    strides
}

// Indexing implementations for convenient access
impl<'a> Index<usize> for TensorView<'a> {
    type Output = f32;

    fn index(&self, index: usize) -> &Self::Output {
        // Return reference to the data stored in the view
        &self.data[self.offset + index]
    }
}

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

    #[test]
    fn test_view_creation() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0, 5.0, 6.0], &[2, 3]).unwrap();
        let view = TensorView::new(&tensor);

        assert_eq!(view.shape(), &[2, 3]);
        assert_eq!(view.strides(), &[3, 1]);
        assert_eq!(view.size(), 6);
        assert!(view.is_contiguous());
    }

    #[test]
    fn test_view_slicing() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0, 5.0, 6.0], &[2, 3]).unwrap();
        let view = TensorView::new(&tensor);

        // Slice first row
        let row_view = view.slice(0, 0..1).unwrap();
        assert_eq!(row_view.shape(), &[1, 3]);

        // Slice first two columns
        let col_view = view.slice(1, 0..2).unwrap();
        assert_eq!(col_view.shape(), &[2, 2]);
    }

    #[test]
    fn test_view_selection() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0, 5.0, 6.0], &[2, 3]).unwrap();
        let view = TensorView::new(&tensor);

        // Select first row
        let row_view = view.select(0, 0).unwrap();
        assert_eq!(row_view.shape(), &[3]);

        // Select first column
        let col_view = view.select(1, 0).unwrap();
        assert_eq!(col_view.shape(), &[2]);
    }

    #[test]
    fn test_view_transpose() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0], &[2, 2]).unwrap();
        let view = TensorView::new(&tensor);

        let transposed = view.transpose().unwrap();
        assert_eq!(transposed.shape(), &[2, 2]);
        assert_eq!(transposed.strides(), &[1, 2]);
    }

    #[test]
    fn test_view_reshape() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0, 5.0, 6.0], &[2, 3]).unwrap();
        let view = TensorView::new(&tensor);

        let reshaped = view.reshape(&[3, 2]).unwrap();
        assert_eq!(reshaped.shape(), &[3, 2]);
        assert_eq!(reshaped.strides(), &[2, 1]);
    }

    #[test]
    fn test_view_squeeze_unsqueeze() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0], &[1, 2, 2]).unwrap();
        let view = TensorView::new(&tensor);

        let squeezed = view.squeeze();
        assert_eq!(squeezed.shape(), &[2, 2]);

        let unsqueezed = squeezed.unsqueeze(1).unwrap();
        assert_eq!(unsqueezed.shape(), &[2, 1, 2]);
    }

    #[test]
    fn test_view_indexing() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0], &[2, 2]).unwrap();
        let view = TensorView::new(&tensor);

        assert_eq!(view.get(&[0, 0]).unwrap(), 1.0);
        assert_eq!(view.get(&[0, 1]).unwrap(), 2.0);
        assert_eq!(view.get(&[1, 0]).unwrap(), 3.0);
        assert_eq!(view.get(&[1, 1]).unwrap(), 4.0);
    }

    #[test]
    fn test_view_to_tensor() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0, 5.0, 6.0], &[2, 3]).unwrap();
        let view = TensorView::new(&tensor);

        let row_view = view.select(0, 0).unwrap();
        let row_tensor = row_view.to_tensor().unwrap();

        assert_eq!(row_tensor.shape(), &[3]);
        assert_eq!(row_tensor.to_vec().unwrap(), vec![1.0, 2.0, 3.0]);
    }

    #[test]
    fn test_view_iterator() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0], &[2, 2]).unwrap();
        let view = TensorView::new(&tensor);

        let values: Result<Vec<f32>> = view.iter().collect();
        assert_eq!(values.unwrap(), vec![1.0, 2.0, 3.0, 4.0]);
    }

    #[test]
    fn test_compute_strides() {
        assert_eq!(compute_strides(&[2, 3, 4]), vec![12usize, 4usize, 1usize]);
        assert_eq!(compute_strides(&[5]), vec![1usize]);
        assert_eq!(compute_strides(&[]), Vec::<usize>::new());
    }

    #[test]
    fn test_axis_iterator() {
        let tensor = Tensor::from_slice(&[1.0, 2.0, 3.0, 4.0, 5.0, 6.0], &[2, 3]).unwrap();
        let view = TensorView::new(&tensor);

        let mut axis_iter = view.axis_iter(0).unwrap();

        let first_row = axis_iter.next().unwrap().unwrap();
        assert_eq!(first_row.shape(), &[3]);

        let second_row = axis_iter.next().unwrap().unwrap();
        assert_eq!(second_row.shape(), &[3]);

        assert!(axis_iter.next().is_none());
    }
}