primal-barracuda 0.4.0

barraCuda — BARrier-free Rust Abstracted Cross-platform Unified Dimensional Algebra. Vendor-agnostic GPU compute via WGSL.
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
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
// SPDX-License-Identifier: AGPL-3.0-or-later
//! Compressed Sparse Row (CSR) matrix format
//!
//! CSR is the standard format for sparse matrix operations:
//! - Efficient row access O(1)
//! - Efficient `SpMV` O(nnz)
//! - Memory: O(nnz + `n_rows`)
//!
//! # Format
//!
//! A CSR matrix stores:
//! - `values`: Non-zero values (length = nnz)
//! - `col_indices`: Column index for each value (length = nnz)
//! - `row_ptr`: Start of each row in `values/col_indices` (length = `n_rows` + 1)
//!
//! # Example
//!
//! ```text
//! Matrix:     CSR:
//! [1 0 2]     values = [1, 2, 3, 4, 5]
//! [0 3 0]     col_indices = [0, 2, 1, 0, 2]
//! [4 0 5]     row_ptr = [0, 2, 3, 5]
//! ```

use crate::error::{BarracudaError, Result};

/// Coordinate (COO) format - easy construction
#[derive(Debug, Clone)]
pub struct CooMatrix {
    /// Number of rows
    pub n_rows: usize,
    /// Number of columns
    pub n_cols: usize,
    /// Row indices
    pub row_indices: Vec<usize>,
    /// Column indices
    pub col_indices: Vec<usize>,
    /// Values
    pub values: Vec<f64>,
}

impl CooMatrix {
    /// Create a new empty COO matrix
    #[must_use]
    pub fn new(n_rows: usize, n_cols: usize) -> Self {
        Self {
            n_rows,
            n_cols,
            row_indices: Vec::new(),
            col_indices: Vec::new(),
            values: Vec::new(),
        }
    }

    /// Create from triplets (row, col, value)
    #[must_use]
    pub fn from_triplets(n_rows: usize, n_cols: usize, triplets: &[(usize, usize, f64)]) -> Self {
        let mut mat = Self::new(n_rows, n_cols);
        for &(row, col, val) in triplets {
            mat.add(row, col, val);
        }
        mat
    }

    /// Add a value at (row, col)
    pub fn add(&mut self, row: usize, col: usize, value: f64) {
        self.row_indices.push(row);
        self.col_indices.push(col);
        self.values.push(value);
    }

    /// Number of non-zeros
    #[must_use]
    pub fn nnz(&self) -> usize {
        self.values.len()
    }

    /// Convert to CSR format
    #[must_use]
    pub fn to_csr(&self) -> CsrMatrix {
        CsrMatrix::from_coo(self)
    }
}

/// Compressed Sparse Row (CSR) matrix format
#[derive(Debug, Clone)]
pub struct CsrMatrix {
    /// Number of rows
    pub n_rows: usize,
    /// Number of columns
    pub n_cols: usize,
    /// Non-zero values (length = nnz)
    pub values: Vec<f64>,
    /// Column indices (length = nnz)
    pub col_indices: Vec<usize>,
    /// Row pointers (length = `n_rows` + 1)
    pub row_ptr: Vec<usize>,
}

impl CsrMatrix {
    /// Create an empty CSR matrix
    #[must_use]
    pub fn new(n_rows: usize, n_cols: usize) -> Self {
        Self {
            n_rows,
            n_cols,
            values: Vec::new(),
            col_indices: Vec::new(),
            row_ptr: vec![0; n_rows + 1],
        }
    }

    /// Create from triplets (row, col, value)
    #[must_use]
    pub fn from_triplets(n_rows: usize, n_cols: usize, triplets: &[(usize, usize, f64)]) -> Self {
        let coo = CooMatrix::from_triplets(n_rows, n_cols, triplets);
        Self::from_coo(&coo)
    }

    /// Create from COO format
    #[must_use]
    pub fn from_coo(coo: &CooMatrix) -> Self {
        let n_rows = coo.n_rows;
        let n_cols = coo.n_cols;
        let nnz = coo.nnz();

        if nnz == 0 {
            return Self::new(n_rows, n_cols);
        }

        // Sort by row, then column
        let mut indices: Vec<usize> = (0..nnz).collect();
        indices.sort_by_key(|&i| (coo.row_indices[i], coo.col_indices[i]));

        // Build CSR arrays
        let mut values = Vec::with_capacity(nnz);
        let mut col_indices = Vec::with_capacity(nnz);
        let mut row_ptr = vec![0; n_rows + 1];

        let mut current_row = 0;
        for &idx in &indices {
            let row = coo.row_indices[idx];

            // Fill row_ptr for any empty rows
            while current_row < row {
                current_row += 1;
                row_ptr[current_row] = values.len();
            }

            values.push(coo.values[idx]);
            col_indices.push(coo.col_indices[idx]);
        }

        // Fill remaining row_ptr entries
        while current_row < n_rows {
            current_row += 1;
            row_ptr[current_row] = values.len();
        }

        Self {
            n_rows,
            n_cols,
            values,
            col_indices,
            row_ptr,
        }
    }

    /// Create from triplets, summing duplicate `(row, col)` entries.
    ///
    /// Scientific codes often accumulate element contributions where the same
    /// `(i, j)` position receives multiple values that should be added. This
    /// builder handles that automatically, unlike [`from_triplets`](Self::from_triplets)
    /// which preserves duplicates as separate entries.
    ///
    /// # Example
    ///
    /// ```
    /// # use barracuda::linalg::sparse::CsrMatrix;
    /// let csr = CsrMatrix::from_triplets_summed(2, 2, &[
    ///     (0, 0, 1.0),
    ///     (0, 0, 2.0),  // duplicate — will be summed
    ///     (1, 1, 3.0),
    /// ]);
    /// assert!((csr.get(0, 0) - 3.0).abs() < 1e-10);
    /// ```
    #[must_use]
    pub fn from_triplets_summed(
        n_rows: usize,
        n_cols: usize,
        triplets: &[(usize, usize, f64)],
    ) -> Self {
        if triplets.is_empty() {
            return Self::new(n_rows, n_cols);
        }

        let mut sorted: Vec<(usize, usize, f64)> = triplets.to_vec();
        sorted.sort_by_key(|&(r, c, _)| (r, c));

        let mut values = Vec::with_capacity(triplets.len());
        let mut col_indices = Vec::with_capacity(triplets.len());
        let mut row_ptr = vec![0usize; n_rows + 1];

        let mut prev_row = sorted[0].0;
        let mut prev_col = sorted[0].1;
        let mut acc = sorted[0].2;

        for &(r, c, v) in &sorted[1..] {
            if r == prev_row && c == prev_col {
                acc += v;
            } else {
                for ptr in &mut row_ptr[prev_row + 1..] {
                    *ptr = values.len() + 1;
                }
                values.push(acc);
                col_indices.push(prev_col);
                prev_row = r;
                prev_col = c;
                acc = v;
            }
        }
        values.push(acc);
        col_indices.push(prev_col);
        for ptr in &mut row_ptr[prev_row + 1..] {
            *ptr = values.len();
        }

        Self {
            n_rows,
            n_cols,
            values,
            col_indices,
            row_ptr,
        }
    }

    /// Create identity matrix
    #[must_use]
    pub fn identity(n: usize) -> Self {
        let triplets: Vec<_> = (0..n).map(|i| (i, i, 1.0)).collect();
        Self::from_triplets(n, n, &triplets)
    }

    /// Create diagonal matrix from values
    #[must_use]
    pub fn from_diagonal(diag: &[f64]) -> Self {
        let n = diag.len();
        let triplets: Vec<_> = diag.iter().enumerate().map(|(i, &v)| (i, i, v)).collect();
        Self::from_triplets(n, n, &triplets)
    }

    /// Create tridiagonal matrix
    /// # Errors
    /// Returns [`Err`] if lower or upper diagonal length does not equal `main.len() - 1`.
    pub fn tridiagonal(lower: &[f64], main: &[f64], upper: &[f64]) -> Result<Self> {
        let n = main.len();
        if lower.len() != n - 1 || upper.len() != n - 1 {
            return Err(BarracudaError::InvalidInput {
                message: "Tridiagonal dimensions mismatch".to_string(),
            });
        }

        let mut triplets = Vec::with_capacity(3 * n - 2);

        // Lower diagonal
        for (i, &v) in lower.iter().enumerate() {
            triplets.push((i + 1, i, v));
        }

        // Main diagonal
        for (i, &v) in main.iter().enumerate() {
            triplets.push((i, i, v));
        }

        // Upper diagonal
        for (i, &v) in upper.iter().enumerate() {
            triplets.push((i, i + 1, v));
        }

        Ok(Self::from_triplets(n, n, &triplets))
    }

    /// Number of non-zeros
    #[must_use]
    pub fn nnz(&self) -> usize {
        self.values.len()
    }

    /// Sparsity (fraction of zeros)
    #[must_use]
    pub fn sparsity(&self) -> f64 {
        let total = self.n_rows * self.n_cols;
        if total == 0 {
            0.0
        } else {
            1.0 - (self.nnz() as f64 / total as f64)
        }
    }

    /// Get value at (row, col) - `O(nnz_row)` lookup
    #[must_use]
    pub fn get(&self, row: usize, col: usize) -> f64 {
        if row >= self.n_rows || col >= self.n_cols {
            return 0.0;
        }

        let row_start = self.row_ptr[row];
        let row_end = self.row_ptr[row + 1];

        for i in row_start..row_end {
            if self.col_indices[i] == col {
                return self.values[i];
            }
        }

        0.0
    }

    /// Get diagonal elements
    #[must_use]
    pub fn diagonal(&self) -> Vec<f64> {
        let n = self.n_rows.min(self.n_cols);
        (0..n).map(|i| self.get(i, i)).collect()
    }

    /// Matrix-vector multiplication: y = A * x
    /// # Errors
    /// Returns [`Err`] if vector length does not match matrix column count.
    pub fn matvec(&self, x: &[f64]) -> Result<Vec<f64>> {
        if x.len() != self.n_cols {
            return Err(BarracudaError::InvalidInput {
                message: format!(
                    "Vector length {} doesn't match matrix columns {}",
                    x.len(),
                    self.n_cols
                ),
            });
        }

        let mut y = vec![0.0; self.n_rows];

        for (y_row, w) in y.iter_mut().zip(self.row_ptr.windows(2)) {
            let row_start = w[0];
            let row_end = w[1];

            for i in row_start..row_end {
                *y_row = self.values[i].mul_add(x[self.col_indices[i]], *y_row);
            }
        }

        Ok(y)
    }

    /// Transpose matrix-vector: y = Aᵀ * x
    /// # Errors
    /// Returns [`Err`] if vector length does not match matrix row count.
    pub fn matvec_transpose(&self, x: &[f64]) -> Result<Vec<f64>> {
        if x.len() != self.n_rows {
            return Err(BarracudaError::InvalidInput {
                message: format!(
                    "Vector length {} doesn't match matrix rows {}",
                    x.len(),
                    self.n_rows
                ),
            });
        }

        let mut y = vec![0.0; self.n_cols];

        for (row, w) in self.row_ptr.windows(2).enumerate() {
            let row_start = w[0];
            let row_end = w[1];
            let x_row = x[row];

            for i in row_start..row_end {
                y[self.col_indices[i]] = self.values[i].mul_add(x_row, y[self.col_indices[i]]);
            }
        }

        Ok(y)
    }

    /// Scale all values by a constant
    pub fn scale(&mut self, alpha: f64) {
        for v in &mut self.values {
            *v *= alpha;
        }
    }

    /// Convert to dense matrix (column-major)
    #[must_use]
    pub fn to_dense(&self) -> Vec<f64> {
        let mut dense = vec![0.0; self.n_rows * self.n_cols];

        for row in 0..self.n_rows {
            let row_start = self.row_ptr[row];
            let row_end = self.row_ptr[row + 1];

            for i in row_start..row_end {
                let col = self.col_indices[i];
                dense[row * self.n_cols + col] = self.values[i];
            }
        }

        dense
    }

    /// Check if matrix is symmetric
    #[must_use]
    pub fn is_symmetric(&self, tol: f64) -> bool {
        if self.n_rows != self.n_cols {
            return false;
        }

        for row in 0..self.n_rows {
            let row_start = self.row_ptr[row];
            let row_end = self.row_ptr[row + 1];

            for i in row_start..row_end {
                let col = self.col_indices[i];
                let val = self.values[i];
                let val_t = self.get(col, row);

                if (val - val_t).abs() > tol {
                    return false;
                }
            }
        }

        true
    }
}

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

    #[test]
    fn test_coo_construction() {
        let mut coo = CooMatrix::new(3, 3);
        coo.add(0, 0, 1.0);
        coo.add(0, 2, 2.0);
        coo.add(1, 1, 3.0);
        coo.add(2, 0, 4.0);
        coo.add(2, 2, 5.0);

        assert_eq!(coo.nnz(), 5);
    }

    #[test]
    fn test_csr_from_triplets() {
        let csr = CsrMatrix::from_triplets(
            3,
            3,
            &[
                (0, 0, 1.0),
                (0, 2, 2.0),
                (1, 1, 3.0),
                (2, 0, 4.0),
                (2, 2, 5.0),
            ],
        );

        assert_eq!(csr.n_rows, 3);
        assert_eq!(csr.n_cols, 3);
        assert_eq!(csr.nnz(), 5);
        assert_eq!(csr.row_ptr, vec![0, 2, 3, 5]);
    }

    #[test]
    fn test_csr_get() {
        let csr = CsrMatrix::from_triplets(
            3,
            3,
            &[
                (0, 0, 1.0),
                (0, 2, 2.0),
                (1, 1, 3.0),
                (2, 0, 4.0),
                (2, 2, 5.0),
            ],
        );

        assert!((csr.get(0, 0) - 1.0).abs() < 1e-10);
        assert!((csr.get(0, 1) - 0.0).abs() < 1e-10);
        assert!((csr.get(0, 2) - 2.0).abs() < 1e-10);
        assert!((csr.get(1, 1) - 3.0).abs() < 1e-10);
        assert!((csr.get(2, 0) - 4.0).abs() < 1e-10);
        assert!((csr.get(2, 2) - 5.0).abs() < 1e-10);
    }

    #[test]
    fn test_csr_matvec() {
        // [1 0 2] [1]   [3]   (1*1 + 0*1 + 2*1 = 3)
        // [0 3 0] [1] = [3]   (0*1 + 3*1 + 0*1 = 3)
        // [4 0 5] [1]   [9]   (4*1 + 0*1 + 5*1 = 9)
        let csr = CsrMatrix::from_triplets(
            3,
            3,
            &[
                (0, 0, 1.0),
                (0, 2, 2.0),
                (1, 1, 3.0),
                (2, 0, 4.0),
                (2, 2, 5.0),
            ],
        );

        let x = vec![1.0, 1.0, 1.0];
        let y = csr.matvec(&x).unwrap();

        assert!((y[0] - 3.0).abs() < 1e-10);
        assert!((y[1] - 3.0).abs() < 1e-10);
        assert!((y[2] - 9.0).abs() < 1e-10);
    }

    #[test]
    fn test_csr_identity() {
        let eye = CsrMatrix::identity(3);

        assert_eq!(eye.nnz(), 3);
        assert!((eye.get(0, 0) - 1.0).abs() < 1e-10);
        assert!((eye.get(1, 1) - 1.0).abs() < 1e-10);
        assert!((eye.get(2, 2) - 1.0).abs() < 1e-10);
        assert!((eye.get(0, 1) - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_csr_diagonal() {
        let mat = CsrMatrix::from_diagonal(&[1.0, 2.0, 3.0]);

        assert_eq!(mat.nnz(), 3);
        assert!((mat.get(0, 0) - 1.0).abs() < 1e-10);
        assert!((mat.get(1, 1) - 2.0).abs() < 1e-10);
        assert!((mat.get(2, 2) - 3.0).abs() < 1e-10);

        let d = mat.diagonal();
        assert_eq!(d, vec![1.0, 2.0, 3.0]);
    }

    #[test]
    fn test_csr_tridiagonal() {
        let lower = vec![-1.0, -1.0];
        let main = vec![2.0, 2.0, 2.0];
        let upper = vec![-1.0, -1.0];

        let tri = CsrMatrix::tridiagonal(&lower, &main, &upper).unwrap();

        assert_eq!(tri.n_rows, 3);
        assert_eq!(tri.nnz(), 7);
        assert!((tri.get(0, 0) - 2.0).abs() < 1e-10);
        assert!((tri.get(0, 1) - (-1.0)).abs() < 1e-10);
        assert!((tri.get(1, 0) - (-1.0)).abs() < 1e-10);
    }

    #[test]
    fn test_csr_sparsity() {
        let csr = CsrMatrix::from_triplets(100, 100, &[(0, 0, 1.0), (50, 50, 2.0)]);

        let sparsity = csr.sparsity();
        assert!(sparsity > 0.99); // 2 non-zeros in 10000 elements
    }

    #[test]
    fn test_csr_symmetric() {
        // Symmetric matrix
        let sym = CsrMatrix::from_triplets(
            3,
            3,
            &[
                (0, 0, 1.0),
                (0, 1, 2.0),
                (1, 0, 2.0),
                (1, 1, 3.0),
                (1, 2, 4.0),
                (2, 1, 4.0),
                (2, 2, 5.0),
            ],
        );
        assert!(sym.is_symmetric(1e-10));

        // Non-symmetric matrix
        let nonsym = CsrMatrix::from_triplets(3, 3, &[(0, 0, 1.0), (0, 1, 2.0), (1, 0, 3.0)]);
        assert!(!nonsym.is_symmetric(1e-10));
    }

    #[test]
    fn test_csr_from_triplets_summed() {
        let csr = CsrMatrix::from_triplets_summed(
            3,
            3,
            &[
                (0, 0, 1.0),
                (0, 0, 2.0),
                (1, 1, 3.0),
                (2, 0, 4.0),
                (2, 0, 1.0),
                (2, 2, 5.0),
            ],
        );
        assert!((csr.get(0, 0) - 3.0).abs() < 1e-10);
        assert!((csr.get(1, 1) - 3.0).abs() < 1e-10);
        assert!((csr.get(2, 0) - 5.0).abs() < 1e-10);
        assert!((csr.get(2, 2) - 5.0).abs() < 1e-10);
    }

    #[test]
    fn test_csr_from_triplets_summed_empty() {
        let csr = CsrMatrix::from_triplets_summed(3, 3, &[]);
        assert_eq!(csr.nnz(), 0);
        assert_eq!(csr.n_rows, 3);
    }

    #[test]
    fn test_csr_to_dense() {
        let csr =
            CsrMatrix::from_triplets(2, 2, &[(0, 0, 1.0), (0, 1, 2.0), (1, 0, 3.0), (1, 1, 4.0)]);

        let dense = csr.to_dense();
        assert_eq!(dense, vec![1.0, 2.0, 3.0, 4.0]);
    }
}