cobre-solver 0.8.0

LP/MIP solver abstraction layer with HiGHS backend for power system optimization
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
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
//! CSR-to-CSC template baking for reusable LP stage templates.
//!
//! Provides [`bake_rows_into_template`], which merges a CSC base template with a
//! CSR row batch into a larger CSC template. The result can be loaded directly via
//! [`crate::SolverInterface::load_model`] without a subsequent `add_rows` call.
//!
//! # Algorithm
//!
//! The merge runs in two sequential passes over columns:
//!
//! 1. **Count pass**: for each CSR row `r`, for each non-zero `k`, increment a
//!    per-column scratch counter `cut_nz_per_col[col_indices[k]]`.
//! 2. **Emit pass**: walk columns `0..num_cols`; for each column `j`, emit the
//!    original base entries from `base.col_starts[j]..base.col_starts[j+1]` followed
//!    by all CSR entries whose column index equals `j`, in ascending CSR row order.
//!
//! The scratch buffer (`Vec<u32>`) is allocated locally on each call. Because
//! `bake_rows_into_template` runs once per training iteration per stage (outside the
//! per-scenario hot path), this allocation is acceptable.
//!
//! # CSC Ordering Convention
//!
//! Within each column the original base rows appear first (in their original CSC
//! order), followed by the appended rows in ascending CSR row order. `HiGHS` does not
//! require sorted per-column row indices, but this convention is maintained for
//! reproducibility and ease of debugging.
//!
//! See [Solver Abstraction SS11.1](../../../cobre-docs/src/specs/architecture/solver-abstraction.md).

use crate::types::{RowBatch, StageTemplate};

/// Merge a CSC base template with a CSR row batch into an output CSC template.
///
/// After return, `out` is a valid [`StageTemplate`] in CSC form with
/// `out.num_rows == base.num_rows + rows.num_rows`.
///
/// # Buffer Reuse
///
/// `out` is cleared and refilled on every call without calling `shrink_to_fit`.
/// Passing the same buffer on every iteration reuses allocations with zero
/// additional allocation at steady state once capacity stabilizes.
///
/// # Preconditions
///
/// Checked via `debug_assert!` in debug builds:
/// - `base.col_starts.len() == base.num_cols + 1` and sentinel `== base.num_nz`
/// - `base.row_indices.len() == base.values.len() == base.num_nz`
/// - `base` column/row bound arrays and objective each have the correct length
/// - `rows.row_starts[0] == 0` (when `rows.num_rows > 0`)
/// - Every `col_indices[k] < base.num_cols`
///
/// # Panics
///
/// Panics if `base.num_nz + rows_nnz` exceeds `i32::MAX` (`HiGHS` API limit).
#[allow(clippy::too_many_lines)] // complex data-structure merge; extracting sub-functions would obscure the algorithm
pub fn bake_rows_into_template(base: &StageTemplate, rows: &RowBatch, out: &mut StageTemplate) {
    // Precondition guards (debug builds only).
    #[allow(clippy::cast_sign_loss)]
    {
        debug_assert_eq!(
            base.col_starts.len(),
            base.num_cols + 1,
            "base.col_starts.len()={} but num_cols+1={}",
            base.col_starts.len(),
            base.num_cols + 1
        );
        debug_assert_eq!(
            base.col_starts.last().copied().unwrap_or(0) as usize,
            base.num_nz,
            "base.col_starts[num_cols] != base.num_nz"
        );
        debug_assert_eq!(base.row_indices.len(), base.num_nz);
        debug_assert_eq!(base.values.len(), base.num_nz);
        debug_assert_eq!(base.col_lower.len(), base.num_cols);
        debug_assert_eq!(base.col_upper.len(), base.num_cols);
        debug_assert_eq!(base.objective.len(), base.num_cols);
        debug_assert_eq!(base.row_lower.len(), base.num_rows);
        debug_assert_eq!(base.row_upper.len(), base.num_rows);
        debug_assert!(
            base.col_scale.is_empty() || base.col_scale.len() == base.num_cols,
            "base.col_scale must be empty or length num_cols"
        );
        debug_assert!(
            base.row_scale.is_empty() || base.row_scale.len() == base.num_rows,
            "base.row_scale must be empty or length num_rows"
        );

        if rows.num_rows > 0 {
            debug_assert_eq!(
                rows.row_starts.len(),
                rows.num_rows + 1,
                "rows.row_starts.len()={} but num_rows+1={}",
                rows.row_starts.len(),
                rows.num_rows + 1
            );
            debug_assert_eq!(
                rows.row_starts[0], 0,
                "RowBatch invariant: row_starts[0] must be 0"
            );
            debug_assert_eq!(rows.row_lower.len(), rows.num_rows);
            debug_assert_eq!(rows.row_upper.len(), rows.num_rows);

            let rows_nnz = rows.row_starts[rows.num_rows] as usize;
            debug_assert_eq!(rows.col_indices.len(), rows_nnz);
            debug_assert_eq!(rows.values.len(), rows_nnz);

            #[cfg(debug_assertions)]
            for &col in &rows.col_indices {
                debug_assert!(
                    (col as usize) < base.num_cols,
                    "col_indices[k]={col} >= base.num_cols={}",
                    base.num_cols
                );
            }
        }
    }

    // Compute total nnz and validate it fits in i32.
    #[allow(clippy::cast_sign_loss)]
    let rows_nnz = if rows.num_rows > 0 {
        rows.row_starts[rows.num_rows] as usize
    } else {
        0
    };
    let total_nnz = base.num_nz + rows_nnz;

    #[allow(clippy::expect_used)]
    let total_nnz_i32 = i32::try_from(total_nnz).expect("total nnz exceeds i32::MAX");

    let num_cols = base.num_cols;
    let num_rows = base.num_rows + rows.num_rows;

    // Pass 1: count CSR row contributions per column.
    let mut cut_nz_per_col: Vec<u32> = vec![0u32; num_cols];
    #[allow(clippy::cast_sign_loss)]
    for &col in &rows.col_indices {
        cut_nz_per_col[col as usize] += 1;
    }

    // Clear buffers (no shrink_to_fit — preserve capacity).
    out.col_starts.clear();
    out.row_indices.clear();
    out.values.clear();
    out.col_lower.clear();
    out.col_upper.clear();
    out.objective.clear();
    out.col_scale.clear();
    out.row_lower.clear();
    out.row_upper.clear();
    out.row_scale.clear();

    // Write scalar fields.
    out.num_cols = num_cols;
    out.num_rows = num_rows;
    out.num_nz = total_nnz;
    out.n_state = base.n_state;
    out.n_transfer = base.n_transfer;
    out.n_dual_relevant = base.n_dual_relevant;
    out.n_hydro = base.n_hydro;
    out.max_par_order = base.max_par_order;

    // Copy column-bound and objective arrays from base.
    out.col_lower.extend_from_slice(&base.col_lower);
    out.col_upper.extend_from_slice(&base.col_upper);
    out.objective.extend_from_slice(&base.objective);
    out.col_scale.extend_from_slice(&base.col_scale);

    // Populate row_lower and row_upper.
    out.row_lower.extend_from_slice(&base.row_lower);
    out.row_lower.extend_from_slice(&rows.row_lower);
    out.row_upper.extend_from_slice(&base.row_upper);
    out.row_upper.extend_from_slice(&rows.row_upper);

    // Populate row_scale: copy base (if non-empty) and append 1.0 for new rows.
    // StageTemplate invariant (types.rs): when non-empty, row_scale.len() must
    // equal num_rows. When the base has scaling and cuts are appended, extend
    // to base+rows; when the base has none but rows are appended, materialise
    // the full scale vector as 1.0 (base rows inherit the "no-op" scale).
    if !base.row_scale.is_empty() {
        out.row_scale.extend_from_slice(&base.row_scale);
        out.row_scale
            .resize(out.row_scale.len() + rows.num_rows, 1.0_f64);
    } else if rows.num_rows > 0 {
        out.row_scale.resize(base.num_rows + rows.num_rows, 1.0_f64);
    }

    // Pass 2: build col_starts, row_indices, values in column order.
    // Compute column start offsets (prefix sum of cut_nz_per_col).
    let mut col_list_start: Vec<u32> = Vec::with_capacity(num_cols + 1);
    let mut running = 0u32;
    for &count in &cut_nz_per_col {
        col_list_start.push(running);
        running += count;
    }
    col_list_start.push(running);

    // Flat scratch buffers for (row_index, value) pairs grouped by column.
    let mut col_list_row: Vec<i32> = vec![0i32; rows_nnz];
    let mut col_list_val: Vec<f64> = vec![0.0f64; rows_nnz];
    let mut write_cursor: Vec<u32> = vec![0u32; num_cols];

    // Fill scratch buffers by scanning CSR rows in ascending order.
    #[allow(clippy::cast_sign_loss)]
    for r in 0..rows.num_rows {
        let start = rows.row_starts[r] as usize;
        let end = rows.row_starts[r + 1] as usize;
        #[allow(clippy::cast_possible_truncation, clippy::cast_possible_wrap)]
        let row_i32 = (base.num_rows + r) as i32;
        for k in start..end {
            let j = rows.col_indices[k] as usize;
            let pos = (col_list_start[j] + write_cursor[j]) as usize;
            col_list_row[pos] = row_i32;
            col_list_val[pos] = rows.values[k];
            write_cursor[j] += 1;
        }
    }

    // Emit col_starts, row_indices, values in column order.
    let mut nz_cursor: i32 = 0;
    #[allow(clippy::cast_sign_loss)]
    for j in 0..num_cols {
        out.col_starts.push(nz_cursor);

        let base_start = base.col_starts[j] as usize;
        let base_end = base.col_starts[j + 1] as usize;
        out.row_indices
            .extend_from_slice(&base.row_indices[base_start..base_end]);
        out.values
            .extend_from_slice(&base.values[base_start..base_end]);

        let list_start = col_list_start[j] as usize;
        let list_end = col_list_start[j + 1] as usize;
        out.row_indices
            .extend_from_slice(&col_list_row[list_start..list_end]);
        out.values
            .extend_from_slice(&col_list_val[list_start..list_end]);

        let col_len = (base_end - base_start) + (list_end - list_start);
        #[allow(clippy::cast_possible_truncation, clippy::cast_possible_wrap)]
        {
            nz_cursor += col_len as i32;
        }
    }
    out.col_starts.push(total_nnz_i32);
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::types::{RowBatch, SolverStatistics, StageTemplate};

    /// Builds the canonical 3-col, 2-row fixture from `types.rs::make_fixture_stage_template`.
    ///
    /// ```
    /// col_starts = [0, 2, 2, 3]
    /// row_indices = [0, 1, 1]
    /// values = [1.0, 2.0, 1.0]
    /// row_lower = [6.0, 14.0]
    /// row_upper = [6.0, 14.0]
    /// ```
    fn make_fixture_stage_template() -> StageTemplate {
        StageTemplate {
            num_cols: 3,
            num_rows: 2,
            num_nz: 3,
            col_starts: vec![0_i32, 2, 2, 3],
            row_indices: vec![0_i32, 1, 1],
            values: vec![1.0, 2.0, 1.0],
            col_lower: vec![0.0, 0.0, 0.0],
            col_upper: vec![10.0, f64::INFINITY, 8.0],
            objective: vec![0.0, 1.0, 50.0],
            row_lower: vec![6.0, 14.0],
            row_upper: vec![6.0, 14.0],
            n_state: 1,
            n_transfer: 0,
            n_dual_relevant: 1,
            n_hydro: 1,
            max_par_order: 0,
            col_scale: Vec::new(),
            row_scale: Vec::new(),
        }
    }

    /// Builds an empty [`RowBatch`] with zero rows (but valid `row_starts` sentinel).
    fn make_empty_row_batch() -> RowBatch {
        RowBatch {
            num_rows: 0,
            row_starts: vec![0_i32],
            col_indices: vec![],
            values: vec![],
            row_lower: vec![],
            row_upper: vec![],
        }
    }

    // -----------------------------------------------------------------------
    // Test 1: empty rows → structural copy of base
    // -----------------------------------------------------------------------

    #[test]
    fn test_bake_empty_rows_copies_base() {
        let base = make_fixture_stage_template();
        let rows = make_empty_row_batch();
        let mut out = StageTemplate::empty();

        bake_rows_into_template(&base, &rows, &mut out);

        assert_eq!(out.num_cols, base.num_cols);
        assert_eq!(out.num_rows, base.num_rows);
        assert_eq!(out.num_nz, base.num_nz);
        assert_eq!(out.col_starts, base.col_starts);
        assert_eq!(out.row_indices, base.row_indices);
        assert_eq!(out.values, base.values);
        assert_eq!(out.col_lower, base.col_lower);
        assert_eq!(out.col_upper, base.col_upper);
        assert_eq!(out.objective, base.objective);
        assert_eq!(out.row_lower, base.row_lower);
        assert_eq!(out.row_upper, base.row_upper);
        assert_eq!(out.n_state, base.n_state);
        assert_eq!(out.n_transfer, base.n_transfer);
        assert_eq!(out.n_dual_relevant, base.n_dual_relevant);
        assert_eq!(out.n_hydro, base.n_hydro);
        assert_eq!(out.max_par_order, base.max_par_order);
        // empty row_scale stays empty
        assert!(out.row_scale.is_empty());
    }

    // -----------------------------------------------------------------------
    // Test 2: single appended row — exact CSC column layout
    // -----------------------------------------------------------------------

    #[test]
    fn test_bake_single_row_appends_correct_column_entries() {
        // Fixture: 3-col, 2-row base as described.
        // RowBatch: one row touching cols 0 and 2.
        let base = make_fixture_stage_template();
        let rows = RowBatch {
            num_rows: 1,
            row_starts: vec![0_i32, 2],
            col_indices: vec![0_i32, 2],
            values: vec![-1.5, 1.0],
            row_lower: vec![10.0],
            row_upper: vec![f64::INFINITY],
        };
        let mut out = StageTemplate::empty();

        bake_rows_into_template(&base, &rows, &mut out);

        assert_eq!(out.num_rows, 3);
        assert_eq!(out.num_nz, 5);

        // Corrected col_starts: col 1 has 0 entries.
        assert_eq!(out.col_starts, vec![0_i32, 3, 3, 5]);

        // Column 0: base rows [0,1] then cut row [2]
        assert_eq!(&out.row_indices[0..3], &[0_i32, 1, 2]);
        assert_eq!(&out.values[0..3], &[1.0_f64, 2.0, -1.5]);

        // Column 1: no entries (col_starts[1]==3, col_starts[2]==3)

        // Column 2: base row [1] then cut row [2]  (positions 3..5)
        assert_eq!(&out.row_indices[3..5], &[1_i32, 2]);
        assert_eq!(&out.values[3..5], &[1.0_f64, 1.0]);

        // Row bounds
        assert_eq!(out.row_lower, vec![6.0_f64, 14.0, 10.0]);
        assert!(out.row_upper[2].is_infinite() && out.row_upper[2] > 0.0);
    }

    // -----------------------------------------------------------------------
    // Test 3: non-empty row_scale — appended cut rows default to 1.0
    // -----------------------------------------------------------------------

    #[test]
    fn test_bake_preserves_row_scale_and_defaults_cut_rows_to_one() {
        let mut base = make_fixture_stage_template();
        base.row_scale = vec![1.0, 2.0];

        let rows = RowBatch {
            num_rows: 1,
            row_starts: vec![0_i32, 1],
            col_indices: vec![0_i32],
            values: vec![-1.0],
            row_lower: vec![5.0],
            row_upper: vec![f64::INFINITY],
        };
        let mut out = StageTemplate::empty();

        bake_rows_into_template(&base, &rows, &mut out);

        assert_eq!(out.row_scale.len(), 3);
        assert_eq!(out.row_scale[0], 1.0);
        assert_eq!(out.row_scale[1], 2.0);
        assert_eq!(out.row_scale[2], 1.0); // cut row implicit scale
    }

    // -----------------------------------------------------------------------
    // Test 4: empty row_scale + zero rows → out.row_scale stays empty
    // -----------------------------------------------------------------------

    #[test]
    fn test_bake_preserves_empty_row_scale_when_no_rows() {
        let base = make_fixture_stage_template(); // row_scale is empty
        let rows = make_empty_row_batch();
        let mut out = StageTemplate::empty();

        bake_rows_into_template(&base, &rows, &mut out);

        assert!(out.row_scale.is_empty());
        assert_eq!(out.num_rows, base.num_rows);
    }

    // -----------------------------------------------------------------------
    // Test 5: reuse out buffer — capacity must not decrease
    // -----------------------------------------------------------------------

    #[test]
    fn test_bake_reuses_out_buffer_capacity() {
        // First call: 5 rows, 10 nz (simulated by a larger base).
        let big_base = StageTemplate {
            num_cols: 2,
            num_rows: 5,
            num_nz: 10,
            col_starts: vec![0_i32, 5, 10],
            row_indices: vec![0_i32, 1, 2, 3, 4, 0, 1, 2, 3, 4],
            values: vec![1.0; 10],
            col_lower: vec![0.0, 0.0],
            col_upper: vec![f64::INFINITY, f64::INFINITY],
            objective: vec![1.0, 1.0],
            row_lower: vec![0.0; 5],
            row_upper: vec![f64::INFINITY; 5],
            n_state: 0,
            n_transfer: 0,
            n_dual_relevant: 0,
            n_hydro: 0,
            max_par_order: 0,
            col_scale: Vec::new(),
            row_scale: Vec::new(),
        };
        let empty_rows = make_empty_row_batch();
        let mut out = StageTemplate::empty();

        bake_rows_into_template(&big_base, &empty_rows, &mut out);

        // Capture capacities after the first (larger) call.
        let cap_col_starts = out.col_starts.capacity();
        let cap_row_indices = out.row_indices.capacity();
        let cap_values = out.values.capacity();
        let cap_row_lower = out.row_lower.capacity();
        let cap_row_upper = out.row_upper.capacity();

        // Second call: 4 rows, 8 nz (smaller — must not reallocate downward).
        let small_base = StageTemplate {
            num_cols: 2,
            num_rows: 4,
            num_nz: 8,
            col_starts: vec![0_i32, 4, 8],
            row_indices: vec![0_i32, 1, 2, 3, 0, 1, 2, 3],
            values: vec![1.0; 8],
            col_lower: vec![0.0, 0.0],
            col_upper: vec![f64::INFINITY, f64::INFINITY],
            objective: vec![1.0, 1.0],
            row_lower: vec![0.0; 4],
            row_upper: vec![f64::INFINITY; 4],
            n_state: 0,
            n_transfer: 0,
            n_dual_relevant: 0,
            n_hydro: 0,
            max_par_order: 0,
            col_scale: Vec::new(),
            row_scale: Vec::new(),
        };

        bake_rows_into_template(&small_base, &empty_rows, &mut out);

        assert_eq!(out.num_rows, 4);
        assert_eq!(out.num_nz, 8);

        // Capacities must not have decreased.
        assert!(out.col_starts.capacity() >= cap_col_starts);
        assert!(out.row_indices.capacity() >= cap_row_indices);
        assert!(out.values.capacity() >= cap_values);
        assert!(out.row_lower.capacity() >= cap_row_lower);
        assert!(out.row_upper.capacity() >= cap_row_upper);
    }

    // -----------------------------------------------------------------------
    // Test 6: determinism — two calls produce identical output
    // -----------------------------------------------------------------------

    #[test]
    fn test_bake_determinism() {
        let base = make_fixture_stage_template();
        let rows = RowBatch {
            num_rows: 2,
            row_starts: vec![0_i32, 2, 3],
            col_indices: vec![0_i32, 2, 1],
            values: vec![-1.0, 0.5, 3.0],
            row_lower: vec![8.0, 12.0],
            row_upper: vec![f64::INFINITY, f64::INFINITY],
        };

        let mut out1 = StageTemplate::empty();
        let mut out2 = StageTemplate::empty();

        bake_rows_into_template(&base, &rows, &mut out1);
        bake_rows_into_template(&base, &rows, &mut out2);

        assert_eq!(out1.col_starts, out2.col_starts);
        assert_eq!(out1.row_indices, out2.row_indices);
        assert_eq!(out1.values, out2.values);
        assert_eq!(out1.row_lower, out2.row_lower);
        assert_eq!(out1.row_upper, out2.row_upper);
    }

    // -----------------------------------------------------------------------
    // Test 7: multi-column distribution — 4-column base, 3 CSR rows
    // -----------------------------------------------------------------------

    #[test]
    fn test_bake_multi_column_distribution() {
        // 4-column, 3-row base:
        //   col 0: rows [0,1]         values [1.0, 2.0]
        //   col 1: row  [2]           value  [3.0]
        //   col 2: rows [0,1,2]       values [4.0, 5.0, 6.0]
        //   col 3: (empty)
        // col_starts = [0, 2, 3, 6, 6]
        let base = StageTemplate {
            num_cols: 4,
            num_rows: 3,
            num_nz: 6,
            col_starts: vec![0_i32, 2, 3, 6, 6],
            row_indices: vec![0_i32, 1, 2, 0, 1, 2],
            values: vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0],
            col_lower: vec![0.0; 4],
            col_upper: vec![f64::INFINITY; 4],
            objective: vec![0.0; 4],
            row_lower: vec![0.0; 3],
            row_upper: vec![f64::INFINITY; 3],
            n_state: 2,
            n_transfer: 1,
            n_dual_relevant: 2,
            n_hydro: 2,
            max_par_order: 1,
            col_scale: Vec::new(),
            row_scale: Vec::new(),
        };

        // 3 CSR rows:
        //   row 3 (cut 0): cols [0, 3]
        //   row 4 (cut 1): cols [1, 2]
        //   row 5 (cut 2): cols [0, 2, 3]
        let rows = RowBatch {
            num_rows: 3,
            row_starts: vec![0_i32, 2, 4, 7],
            col_indices: vec![0_i32, 3, 1, 2, 0, 2, 3],
            values: vec![-1.0, 1.0, -2.0, 2.0, -3.0, 3.0, -4.0],
            row_lower: vec![10.0, 20.0, 30.0],
            row_upper: vec![f64::INFINITY; 3],
        };

        let mut out = StageTemplate::empty();
        bake_rows_into_template(&base, &rows, &mut out);

        assert_eq!(out.num_rows, 6);
        // col 0: 2 base + 2 cut (rows 3, 5) = 4
        // col 1: 1 base + 1 cut (row 4) = 2
        // col 2: 3 base + 2 cut (rows 4, 5) = 5
        // col 3: 0 base + 2 cut (rows 3, 5) = 2
        // total = 13
        assert_eq!(out.num_nz, 13);
        assert_eq!(out.col_starts, vec![0_i32, 4, 6, 11, 13]);

        // Column 0 entries: base rows [0,1], then cut rows [3,5]
        assert_eq!(&out.row_indices[0..4], &[0_i32, 1, 3, 5]);
        assert_eq!(&out.values[0..4], &[1.0_f64, 2.0, -1.0, -3.0]);

        // Column 1 entries: base row [2], then cut row [4]
        assert_eq!(&out.row_indices[4..6], &[2_i32, 4]);
        assert_eq!(&out.values[4..6], &[3.0_f64, -2.0]);

        // Column 2 entries: base rows [0,1,2], then cut rows [4,5]
        assert_eq!(&out.row_indices[6..11], &[0_i32, 1, 2, 4, 5]);
        assert_eq!(&out.values[6..11], &[4.0_f64, 5.0, 6.0, 2.0, 3.0]);

        // Column 3 entries: base (empty), then cut rows [3,5]
        assert_eq!(&out.row_indices[11..13], &[3_i32, 5]);
        assert_eq!(&out.values[11..13], &[1.0_f64, -4.0]);

        // Row bounds
        assert_eq!(&out.row_lower[3..6], &[10.0_f64, 20.0, 30.0]);
    }

    // -----------------------------------------------------------------------
    // Test 8: MockSolver records num_rows from load_model
    // -----------------------------------------------------------------------

    /// A minimal [`crate::SolverInterface`] implementation that records the
    /// `num_rows` value from the most recent `load_model` call.
    struct MockSolver {
        last_loaded_num_rows: usize,
        stats: SolverStatistics,
    }

    impl MockSolver {
        fn new() -> Self {
            Self {
                last_loaded_num_rows: 0,
                stats: SolverStatistics::default(),
            }
        }
    }

    impl crate::SolverInterface for MockSolver {
        type Profile = crate::HighsProfile;

        fn apply_profile(&mut self, _profile: &crate::HighsProfile) {}

        fn load_model(&mut self, template: &StageTemplate) {
            self.last_loaded_num_rows = template.num_rows;
            self.stats.load_model_count += 1;
        }

        fn add_rows(&mut self, _rows: &RowBatch) {}

        fn set_row_bounds(&mut self, _indices: &[usize], _lower: &[f64], _upper: &[f64]) {}

        fn set_col_bounds(&mut self, _indices: &[usize], _lower: &[f64], _upper: &[f64]) {}

        fn solve(
            &mut self,
            _basis: Option<&crate::types::Basis>,
        ) -> Result<crate::types::SolutionView<'_>, crate::types::SolverError> {
            Err(crate::types::SolverError::InternalError {
                message: "mock".to_string(),
                error_code: None,
            })
        }

        fn get_basis(&mut self, _out: &mut crate::types::Basis) {}

        fn statistics(&self) -> SolverStatistics {
            self.stats.clone()
        }

        fn name(&self) -> &'static str {
            "Mock"
        }

        fn solver_name_version(&self) -> String {
            "MockSolver 0.0.0".to_string()
        }

        fn set_primal_feasibility_tolerance(&mut self, _value: f64) {}

        fn set_dual_feasibility_tolerance(&mut self, _value: f64) {}

        fn set_simplex_iteration_limit_profile(&mut self, _value: u32) {}

        fn set_ipm_iteration_limit_profile(&mut self, _value: u32) {}
    }

    #[test]
    fn test_bake_load_model_row_count() {
        use crate::SolverInterface;

        let base = make_fixture_stage_template();
        let rows = RowBatch {
            num_rows: 3,
            row_starts: vec![0_i32, 1, 2, 3],
            col_indices: vec![0_i32, 1, 2],
            values: vec![-1.0, -1.0, -1.0],
            row_lower: vec![5.0, 6.0, 7.0],
            row_upper: vec![f64::INFINITY; 3],
        };

        let mut out = StageTemplate::empty();
        bake_rows_into_template(&base, &rows, &mut out);

        let expected_rows = base.num_rows + rows.num_rows; // 2 + 3 = 5

        let mut solver = MockSolver::new();
        let before = solver.statistics().load_model_count;
        solver.load_model(&out);
        let after = solver.statistics().load_model_count;

        assert_eq!(after - before, 1);
        assert_eq!(solver.last_loaded_num_rows, expected_rows);
    }

    // -----------------------------------------------------------------------
    // Test (extra): empty row_scale + non-zero rows → appended 1.0 entries only
    // -----------------------------------------------------------------------

    #[test]
    fn test_bake_empty_base_row_scale_with_cut_rows_appends_ones() {
        let base = make_fixture_stage_template(); // row_scale is empty
        let rows = RowBatch {
            num_rows: 2,
            row_starts: vec![0_i32, 1, 2],
            col_indices: vec![0_i32, 0],
            values: vec![-1.0, -2.0],
            row_lower: vec![5.0, 6.0],
            row_upper: vec![f64::INFINITY; 2],
        };
        let mut out = StageTemplate::empty();

        bake_rows_into_template(&base, &rows, &mut out);

        // StageTemplate invariant: when non-empty, row_scale.len() == num_rows.
        // base.row_scale was empty but rows.num_rows == 2, so the baked template
        // materialises a full row_scale of 1.0 (base.num_rows + rows.num_rows == 4).
        assert_eq!(out.row_scale.len(), base.num_rows + rows.num_rows);
        assert!(out.row_scale.iter().all(|&s| s == 1.0));
    }

    // -----------------------------------------------------------------------
    // Test: i32::MAX overflow panics
    //
    // Reaching the `i32::try_from` check without OOM requires lying about
    // `num_nz` while keeping the backing Vecs empty. In debug builds,
    // `debug_assert!(base.row_indices.len() == base.num_nz)` fires before the
    // overflow check, so the test is restricted to `#[cfg(not(debug_assertions))]`
    // (i.e., `cargo test --release`).
    // -----------------------------------------------------------------------

    /// Verifies that `bake_rows_into_template` panics with the expected message
    /// when `base.num_nz + rows_nnz` exceeds `i32::MAX`.
    ///
    /// Skipped in debug builds because `debug_assert!` on `base.row_indices.len()`
    /// fires before the overflow guard when `num_nz` is fabricated. The
    /// `i32::try_from` path exists in both builds; run `cargo test --release` to
    /// exercise it directly.
    #[test]
    #[cfg(not(debug_assertions))]
    #[should_panic(expected = "total nnz exceeds i32::MAX")]
    fn test_bake_panics_on_nnz_overflow() {
        // base: zero columns, zero actual non-zeros, but num_nz = i32::MAX.
        // In release mode, debug_asserts are disabled so the i32::try_from guard
        // is reached before any length check. rows contributes 1 extra non-zero
        // (rows_nnz = 1), making total_nnz = i32::MAX + 1 which overflows i32.
        let large_num_nz = usize::try_from(i32::MAX).unwrap(); // 2_147_483_647
        let base = StageTemplate {
            num_cols: 0,
            num_rows: 0,
            num_nz: large_num_nz,
            col_starts: vec![0_i32], // len = num_cols + 1 = 1
            row_indices: vec![],     // empty — debug_asserts disabled in release
            values: vec![],
            col_lower: vec![],
            col_upper: vec![],
            objective: vec![],
            row_lower: vec![],
            row_upper: vec![],
            n_state: 0,
            n_transfer: 0,
            n_dual_relevant: 0,
            n_hydro: 0,
            max_par_order: 0,
            col_scale: Vec::new(),
            row_scale: Vec::new(),
        };
        // rows contributes 1 non-zero, tipping base.num_nz + 1 > i32::MAX.
        // col_indices = [0] would be out-of-range for num_cols == 0, but the
        // corresponding debug_assert is also disabled in release mode; the
        // i32::try_from check fires first because total_nnz is computed before
        // any further use of col_indices.
        let rows = RowBatch {
            num_rows: 1,
            row_starts: vec![0_i32, 1],
            col_indices: vec![0_i32],
            values: vec![1.0],
            row_lower: vec![0.0],
            row_upper: vec![f64::INFINITY],
        };
        let mut out = StageTemplate::empty();
        bake_rows_into_template(&base, &rows, &mut out);
    }
}