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
use crate::column::{LazyColumn, LazySparseColumn, SparseColumnRef};
use crate::normalization::{Normalization, NormalizationParams};
use crate::row::LazyRow;
use crate::traits::{
ColumnStats, Columns, DotSlice, ElemDivAssign, MatTransposeVec, MatTransposeVecInto,
MatTransposeVecScaledInto, MatVec, MatVecInto, MatVecScaledInto, MatrixShape, RawColumns,
Scalar, ScaledSubSlice, SparseColumns, SparseRows, SubScalarAssign, SumEntries, VectorOwned,
VectorView, VectorViewMut,
};
/// A matrix presented with lazy column normalization `X̃ = (X − 1cᵀ)S⁻¹`.
///
/// The underlying matrix `data` is never modified or densified; the centers and
/// scales are folded into the matrix–vector products on the fly. See the
/// [crate-level documentation](crate) for the math.
///
/// `centers` and `scales` are each `None` when that axis of normalization is
/// inactive. When present, each has length `ncols`, and no scale equals zero.
/// Negative scales and nonfinite normalization parameters are allowed.
#[derive(Clone, Debug)]
pub struct LazyMatrix<M, F = f64> {
data: M,
normalization: NormalizationParams<F>,
}
impl<M, F: Scalar> LazyMatrix<M, F>
where
M: MatrixShape,
{
/// Construct from an explicit center and/or scale vector.
///
/// Parameters are preserved unchanged, including negative scales and
/// nonfinite values. Unlike [`Self::new`], this constructor rejects exact
/// zero scales rather than replacing them with one.
///
/// # Panics
/// Panics if a provided `centers`/`scales` vector does not have length
/// `ncols`, or if a scale is `+0.0` or `-0.0`. The zero-scale panic reports
/// the zero-based column index.
pub fn from_parts(data: M, centers: Option<Vec<F>>, scales: Option<Vec<F>>) -> Self {
let normalization = NormalizationParams::from_parts(data.ncols(), centers, scales);
Self::from_normalization(data, normalization)
}
/// Wrap raw data using previously fitted parameters.
///
/// # Panics
/// Panics if the matrix column count differs from the fitted column count.
pub fn from_normalization(data: M, normalization: NormalizationParams<F>) -> Self {
assert_eq!(
data.ncols(),
normalization.ncols(),
"normalization column count must equal ncols"
);
Self {
data,
normalization,
}
}
/// Borrow fitted parameters for reuse on prediction data.
pub fn normalization(&self) -> &NormalizationParams<F> {
&self.normalization
}
/// Wrap a matrix with column centering only.
///
/// Centers are preserved unchanged, including nonfinite values.
///
/// # Panics
/// Panics if `centers.len() != ncols`.
pub fn with_centers(data: M, centers: Vec<F>) -> Self {
Self::from_parts(data, Some(centers), None)
}
/// Wrap a matrix with column scaling only.
///
/// Scales are preserved unchanged, including negative and nonfinite values.
/// Exact zero scales are rejected, as in [`Self::from_parts`].
///
/// # Panics
/// Panics if `scales.len() != ncols`, or if a scale is `+0.0` or `-0.0`.
/// The zero-scale panic reports the zero-based column index.
pub fn with_scales(data: M, scales: Vec<F>) -> Self {
Self::from_parts(data, None, Some(scales))
}
/// Number of rows of the logical normalized matrix.
pub fn nrows(&self) -> usize {
self.data.nrows()
}
/// Number of columns of the logical normalized matrix.
pub fn ncols(&self) -> usize {
self.data.ncols()
}
/// The column centers `c`, if centering is active.
pub fn centers(&self) -> Option<&[F]> {
self.normalization.centers.as_deref()
}
/// The column scales `s`, if scaling is active.
pub fn scales(&self) -> Option<&[F]> {
self.normalization.scales.as_deref()
}
/// Borrow the underlying (un-normalized) matrix.
pub fn data(&self) -> &M {
&self.data
}
/// Borrow one lazily normalized column without copying.
pub fn column(&self, j: usize) -> LazyColumn<M::Column<'_>, F>
where
M: RawColumns<F>,
{
assert!(j < self.ncols(), "column index out of bounds");
LazyColumn::new(
self.data.raw_column(j),
self.normalization
.centers
.as_ref()
.map_or_else(F::zero, |c| c[j]),
self.normalization
.scales
.as_ref()
.map_or_else(F::one, |s| s[j]),
)
}
/// Borrow one lazily normalized CSC column with its sparse representation.
pub fn sparse_column(&self, j: usize) -> LazySparseColumn<'_, F>
where
M: SparseColumns<F>,
{
assert!(j < self.ncols(), "column index out of bounds");
let (row_indices, values) = self.data.sparse_column(j);
LazyColumn::new(
SparseColumnRef::new(row_indices, values, self.nrows()),
self.normalization
.centers
.as_ref()
.map_or_else(F::zero, |c| c[j]),
self.normalization
.scales
.as_ref()
.map_or_else(F::one, |s| s[j]),
)
}
/// Borrow one lazily normalized sparse row without copying.
///
/// This takes O(1) time and allocates nothing. The view borrows the raw
/// stored column indices and values and the full normalization slices.
/// Centering generally makes the logical row dense; [`LazyRow`] exposes
/// its sparse-plus-affine representation explicitly.
///
/// ```
/// # #[cfg(feature = "sprs_all")]
/// # {
/// use lazymatrix::{LazyMatrix, SprsCsr};
/// use sprs::CsMat;
///
/// let x = CsMat::new((1, 3), vec![0, 2], vec![0, 2], vec![1.0, 0.0]);
/// let csr = SprsCsr::try_new(x.view()).unwrap();
/// let lazy = LazyMatrix::from_parts(csr, Some(vec![0.5, -1.0, 2.0]), Some(vec![2.0; 3]));
/// let row = lazy.row(0);
/// assert_eq!(row.len(), 3);
/// assert_eq!(row.column_indices(), &[0, 2]);
/// assert_eq!(row.values(), &[1.0, 0.0]);
/// assert_eq!(row.implicit_value(1), 0.5);
/// assert_eq!(row.stored_corrections().collect::<Vec<_>>(), vec![(0, 0.5), (2, 0.0)]);
/// # }
/// ```
///
/// Row access requires contiguous sparse-row storage:
///
/// ```compile_fail
/// use lazymatrix::{LazyMatrix, MatrixShape};
///
/// fn row_without_sparse_rows<M: MatrixShape>(matrix: &LazyMatrix<M>) {
/// let _ = matrix.row(0);
/// }
/// ```
///
/// # Panics
///
/// Panics if `i >= self.nrows()`.
pub fn row(&self, i: usize) -> LazyRow<'_, F>
where
M: SparseRows<F>,
{
assert!(i < self.nrows(), "row index out of bounds");
let (column_indices, values) = self.data.sparse_row(i);
LazyRow::new(
column_indices,
values,
self.ncols(),
self.centers(),
self.scales(),
)
}
/// Consume the wrapper, returning the underlying matrix and the
/// center/scale vectors.
pub fn into_parts(self) -> (M, Option<Vec<F>>, Option<Vec<F>>) {
(
self.data,
self.normalization.centers,
self.normalization.scales,
)
}
}
impl<M, F: Scalar> LazyMatrix<M, F>
where
M: ColumnStats<F> + MatrixShape,
{
/// Construct by **computing** the centers and scales from `data` according
/// to `spec`.
///
/// When both centering and scaling are requested, scales are computed from
/// the *centered* columns. Standard deviation and range are
/// centering-invariant; `L1`, `L2`, and `MaxAbs` use sparse closed-form
/// centered variants.
///
/// An exact zero scale (e.g. a constant column whose standard deviation is
/// zero) is replaced with `1`, so the resulting operator never divides by
/// zero. Nonfinite statistics retain their IEEE values and propagate through
/// subsequent operations.
///
/// # Errors
/// Returns the backend error if computing normalization statistics fails.
pub fn new(data: M, spec: Normalization) -> Result<Self, M::Error> {
let (centers, scales) = data.normalization_stats(spec)?;
Ok(Self::from_parts(
data,
centers,
scales.map(replace_zero_scales),
))
}
}
impl<M, F> MatrixShape for LazyMatrix<M, F>
where
M: MatrixShape,
{
fn nrows(&self) -> usize {
self.data.nrows()
}
fn ncols(&self) -> usize {
self.data.ncols()
}
}
impl<M, F> Columns<F> for LazyMatrix<M, F>
where
F: Scalar,
M: RawColumns<F>,
{
type Column<'a>
= LazyColumn<M::Column<'a>, F>
where
Self: 'a;
fn column(&self, j: usize) -> Self::Column<'_> {
LazyMatrix::column(self, j)
}
}
/// Replace exact zero entries with `1`, leaving nonfinite values untouched.
///
/// Mirrors the zero-variance guard used in standard penalized-regression
/// preprocessing: a constant column has scale `0`, which would otherwise produce
/// a division by zero; replacing it with `1` makes that column a no-op under
/// scaling.
fn replace_zero_scales<F: Scalar>(mut scales: Vec<F>) -> Vec<F> {
let one = F::one();
let zero = F::zero();
for s in &mut scales {
if *s == zero {
*s = one;
}
}
scales
}
impl<M, V, F> MatVec<V> for LazyMatrix<M, F>
where
F: Scalar,
M: MatVec<V>,
V: Clone + ElemDivAssign<F> + DotSlice<F> + SubScalarAssign<F>,
{
/// `X̃ v = X (S⁻¹ v) − 1 · (cᵀ S⁻¹ v)`.
fn matvec(&self, v: &V) -> Result<V, Self::Error> {
// The forward op clones `v` because it mutates it into `S⁻¹v`. The
// transpose op below does NOT clone `u`: it reads `Σu` first, then only
// reads `u` through the backend product.
let mut w = v.clone();
if let Some(s) = &self.normalization.scales {
w.elem_div_assign(s); // w = S⁻¹ v
}
let mut y = self.data.matvec(&w)?;
if let Some(c) = &self.normalization.centers {
y.sub_scalar_assign(w.dot_slice(c)); // y −= 1 · (cᵀ w)
}
Ok(y)
}
}
impl<M, X, Y, F> MatVecInto<X, Y> for LazyMatrix<M, F>
where
F: Scalar,
M: MatVecInto<X, Y>,
X: Clone + ElemDivAssign<F> + DotSlice<F>,
Y: SubScalarAssign<F>,
{
/// `out = X̃ v = X (S⁻¹ v) − 1 · (cᵀ S⁻¹ v)`.
fn matvec_into(&self, v: &X, out: &mut Y) -> Result<(), Self::Error> {
self.data
.matvec_normalized_into(v, self.centers(), self.scales(), out)
}
}
impl<M, V, F> MatTransposeVec<V> for LazyMatrix<M, F>
where
F: Scalar,
M: MatTransposeVec<V>,
V: SumEntries<F> + ScaledSubSlice<F> + ElemDivAssign<F>,
{
/// `X̃ᵀ u = S⁻¹ (Xᵀ u − c · Σu)`.
fn mat_transpose_vec(&self, u: &V) -> Result<V, Self::Error> {
let total = if self.normalization.centers.is_some() {
u.sum_entries()
} else {
F::zero()
};
let mut t = self.data.mat_transpose_vec(u)?;
if let Some(c) = &self.normalization.centers {
t.scaled_sub_slice(total, c); // t −= Σu · c
}
if let Some(s) = &self.normalization.scales {
t.elem_div_assign(s); // t = S⁻¹ t
}
Ok(t)
}
}
impl<M, X, Y, F> MatTransposeVecInto<X, Y> for LazyMatrix<M, F>
where
F: Scalar,
M: MatTransposeVecInto<X, Y>,
X: SumEntries<F>,
Y: ScaledSubSlice<F> + ElemDivAssign<F>,
{
/// `out = X̃ᵀ u = S⁻¹ (Xᵀ u − c · Σu)`.
fn mat_transpose_vec_into(&self, u: &X, out: &mut Y) -> Result<(), Self::Error> {
self.data
.mat_transpose_vec_normalized_into(u, self.centers(), self.scales(), out)
}
}
impl<M, F: Scalar> LazyMatrix<M, F>
where
M: MatrixShape,
{
/// Apply `out = alpha * X̃ * x + beta * out` using caller-owned coefficient scratch.
///
/// `scratch` must have length `ncols`. It is used when column scaling is
/// active, and its contents after the call are unspecified on error.
pub fn matvec_scaled_with_workspace<X, Y>(
&self,
alpha: F,
x: &X,
beta: F,
out: &mut Y,
scratch: &mut X::Owned,
) -> Result<(), M::Error>
where
X: VectorOwned<F>,
Y: VectorViewMut<F>,
M: MatVecScaledInto<X, Y, F> + MatVecScaledInto<X::Owned, Y, F>,
{
assert_eq!(
x.len(),
self.ncols(),
"matvec_scaled_into: dimension mismatch"
);
assert_eq!(
out.len(),
self.nrows(),
"matvec_scaled_into: output dimension mismatch"
);
assert_eq!(
scratch.len(),
self.ncols(),
"matvec_scaled_into: scratch dimension mismatch"
);
if let Some(scales) = self
.normalization
.scales
.as_ref()
.filter(|_| alpha != F::zero())
{
for (j, &scale) in scales.iter().enumerate() {
scratch.set(j, x.get(j) / scale);
}
self.data.matvec_scaled_into(alpha, scratch, beta, out)?;
if let Some(centers) = &self.normalization.centers {
let correction: F = (0..self.ncols()).map(|j| scratch.get(j) * centers[j]).sum();
for i in 0..out.len() {
out.set(i, out.get(i) - alpha * correction);
}
}
} else {
self.data.matvec_scaled_into(alpha, x, beta, out)?;
if let Some(centers) = self
.normalization
.centers
.as_ref()
.filter(|_| alpha != F::zero())
{
let correction: F = (0..self.ncols()).map(|j| x.get(j) * centers[j]).sum();
for i in 0..out.len() {
out.set(i, out.get(i) - alpha * correction);
}
}
}
Ok(())
}
/// Apply `out = alpha * X̃ᵀ * x + beta * out` using caller-owned scratch.
///
/// `scratch` must have length `ncols`. Scaling with nonzero `alpha` uses
/// this buffer to keep the previous `out` values separate from the raw
/// transpose product.
pub fn mat_transpose_vec_scaled_with_workspace<X, Y>(
&self,
alpha: F,
x: &X,
beta: F,
out: &mut Y,
scratch: &mut Y::Owned,
) -> Result<(), M::Error>
where
X: VectorView<F>,
Y: VectorOwned<F> + VectorViewMut<F>,
M: MatTransposeVecScaledInto<X, Y, F> + MatTransposeVecScaledInto<X, Y::Owned, F>,
{
assert_eq!(
x.len(),
self.nrows(),
"mat_transpose_vec_scaled_into: dimension mismatch"
);
assert_eq!(
out.len(),
self.ncols(),
"mat_transpose_vec_scaled_into: output dimension mismatch"
);
assert_eq!(
scratch.len(),
self.ncols(),
"mat_transpose_vec_scaled_into: scratch dimension mismatch"
);
if let Some(scales) = self
.normalization
.scales
.as_ref()
.filter(|_| alpha != F::zero())
{
self.data
.mat_transpose_vec_scaled_into(F::one(), x, F::zero(), scratch)?;
let total = if self.normalization.centers.is_some() {
x.sum()
} else {
F::zero()
};
for (j, &scale) in scales.iter().enumerate() {
let center = self
.normalization
.centers
.as_ref()
.map_or_else(F::zero, |c| c[j]);
let product = alpha * ((scratch.get(j) - center * total) / scale);
out.set(
j,
if beta == F::zero() {
product
} else {
product + beta * out.get(j)
},
);
}
} else {
self.data
.mat_transpose_vec_scaled_into(alpha, x, beta, out)?;
if let Some(centers) = self
.normalization
.centers
.as_ref()
.filter(|_| alpha != F::zero())
{
let total = x.sum();
for (j, ¢er) in centers.iter().enumerate() {
out.set(j, out.get(j) - alpha * center * total);
}
}
}
Ok(())
}
}
impl<M, X, Y, F> MatVecScaledInto<X, Y, F> for LazyMatrix<M, F>
where
F: Scalar,
X: VectorOwned<F>,
Y: VectorViewMut<F>,
M: MatVecScaledInto<X, Y, F> + MatVecScaledInto<X::Owned, Y, F>,
{
fn matvec_scaled_into(&self, alpha: F, x: &X, beta: F, out: &mut Y) -> Result<(), Self::Error> {
assert_eq!(
x.len(),
self.ncols(),
"matvec_scaled_into: dimension mismatch"
);
assert_eq!(
out.len(),
self.nrows(),
"matvec_scaled_into: output dimension mismatch"
);
if self.normalization.scales.is_some() && alpha != F::zero() {
let mut scratch = X::owned_from_fn(self.ncols(), |_| F::zero());
self.matvec_scaled_with_workspace(alpha, x, beta, out, &mut scratch)
} else {
self.data.matvec_scaled_into(alpha, x, beta, out)?;
if let Some(centers) = self
.normalization
.centers
.as_ref()
.filter(|_| alpha != F::zero())
{
let correction: F = (0..self.ncols()).map(|j| x.get(j) * centers[j]).sum();
for i in 0..out.len() {
out.set(i, out.get(i) - alpha * correction);
}
}
Ok(())
}
}
}
impl<M, X, Y, F> MatTransposeVecScaledInto<X, Y, F> for LazyMatrix<M, F>
where
F: Scalar,
X: VectorView<F>,
Y: VectorOwned<F> + VectorViewMut<F>,
M: MatTransposeVecScaledInto<X, Y, F> + MatTransposeVecScaledInto<X, Y::Owned, F>,
{
fn mat_transpose_vec_scaled_into(
&self,
alpha: F,
x: &X,
beta: F,
out: &mut Y,
) -> Result<(), Self::Error> {
assert_eq!(
x.len(),
self.nrows(),
"mat_transpose_vec_scaled_into: dimension mismatch"
);
assert_eq!(
out.len(),
self.ncols(),
"mat_transpose_vec_scaled_into: output dimension mismatch"
);
if self.normalization.scales.is_some() && alpha != F::zero() {
let mut scratch = Y::owned_from_fn(self.ncols(), |_| F::zero());
self.mat_transpose_vec_scaled_with_workspace(alpha, x, beta, out, &mut scratch)
} else {
self.data
.mat_transpose_vec_scaled_into(alpha, x, beta, out)?;
if let Some(centers) = self
.normalization
.centers
.as_ref()
.filter(|_| alpha != F::zero())
{
let total = x.sum();
for (j, ¢er) in centers.iter().enumerate() {
out.set(j, out.get(j) - alpha * center * total);
}
}
Ok(())
}
}
}
impl<M: crate::MatrixErrorType, F> crate::MatrixErrorType for LazyMatrix<M, F> {
type Error = M::Error;
}
impl<M, F> crate::WeightedGramInto<F> for LazyMatrix<M, F>
where
F: Scalar,
M: crate::WeightedGramKernel<F>,
{
fn weighted_gram_into<W, O>(&self, weights: &W, out: &mut O) -> Result<(), Self::Error>
where
W: crate::VectorView<F> + ?Sized,
O: crate::MatrixWrite<F> + ?Sized,
{
crate::gram::validate(
self.nrows(),
self.ncols(),
weights,
self.centers(),
self.scales(),
out,
);
self.data
.weighted_gram_normalized_into(weights, self.centers(), self.scales(), out)
}
}
impl<M, F> crate::WeightedColumnSumsInto<F> for LazyMatrix<M, F>
where
F: Scalar,
M: crate::WeightedColumnSumsKernel<F>,
{
fn weighted_column_sums_into<W, O>(&self, weights: &W, out: &mut O) -> Result<(), Self::Error>
where
W: crate::VectorView<F> + ?Sized,
O: crate::VectorViewMut<F> + ?Sized,
{
crate::weighted_sums::validate(
self.nrows(),
self.ncols(),
weights,
self.centers(),
self.scales(),
out,
);
self.data
.weighted_column_sums_normalized_into(weights, self.centers(), self.scales(), out)
}
}
impl<M: crate::MaterializeDense<F>, F: Scalar> LazyMatrix<M, F> {
/// Allocate normalized dense storage in the selected backend.
///
/// Sparse and storage-backed inputs are explicitly materialized. Fitted
/// statistics are retained without recomputation. This requires O(nrows *
/// ncols) output storage, plus backend workspace. Allocation size overflow
/// panics; allocation failures follow the selected backend's behavior.
///
/// # Errors
/// Returns the source error if reading the matrix fails.
pub fn to_eager<D: crate::MatrixOwned<F>>(&self) -> Result<crate::EagerMatrix<D, F>, M::Error> {
crate::materialize::validate_allocation::<F>(self.nrows(), self.ncols());
let mut data = D::zeros(self.nrows(), self.ncols());
crate::materialize::validate_output(self, &data, self.centers(), self.scales());
self.data
.materialize_normalized_into(self.centers(), self.scales(), &mut data)?;
Ok(crate::EagerMatrix::from_normalized(
data,
self.normalization.clone(),
))
}
/// Overwrite dense storage and return a normalized operator borrowing it.
///
/// No matrix allocation is made. Fitted parameters are cloned, and the
/// backend may allocate workspace. The wrapper borrows only the output.
///
/// The output remains exclusively borrowed while the wrapper is in use:
///
/// ```compile_fail
/// use lazymatrix::{LazyMatrix, MaterializeDense, MatrixWrite};
/// fn cannot_reuse_output<M: MaterializeDense<f64>, D: MatrixWrite<f64>>(
/// matrix: &LazyMatrix<M>, out: &mut D,
/// ) {
/// let eager = matrix.to_eager_into(out).unwrap();
/// out.set(0, 0, 0.0);
/// let _ = eager.nrows();
/// }
/// ```
///
/// # Errors
/// On a source error, output may be partial and no wrapper is returned.
///
/// # Panics
/// Panics before writing if the output shape differs from the input shape.
pub fn to_eager_into<'a, D: crate::MatrixWrite<F> + ?Sized>(
&self,
out: &'a mut D,
) -> Result<crate::EagerMatrix<&'a mut D, F>, M::Error> {
crate::materialize::validate_output(self, out, self.centers(), self.scales());
self.data
.materialize_normalized_into(self.centers(), self.scales(), out)?;
Ok(crate::EagerMatrix::from_normalized(
out,
self.normalization.clone(),
))
}
}
impl<M: crate::DenseNormalize<F>, F: Scalar> LazyMatrix<M, F> {
/// Consume writable dense data, normalizing it in its existing allocation.
///
/// Mutable views modify their borrowed storage. All statistics have already
/// been fitted, and no new statistics or full matrix allocation are needed.
///
/// Borrowed immutable and sparse storage do not support in-place conversion:
///
/// ```compile_fail
/// use lazymatrix::{LazyMatrix, MatrixShape};
/// fn needs_writable_dense_storage<M: MatrixShape>(matrix: LazyMatrix<M>) {
/// let _ = matrix.into_eager();
/// }
/// ```
pub fn into_eager(mut self) -> crate::EagerMatrix<M, F> {
self.data
.normalize_in_place(self.normalization.centers(), self.normalization.scales());
crate::EagerMatrix::from_normalized(self.data, self.normalization)
}
}