Skip to main content

MatRef

Type Alias MatRef 

Source
pub type MatRef<'a, T, Rows = usize, Cols = usize, RStride = isize, CStride = isize> = Mat<Ref<'a, T, Rows, Cols, RStride, CStride>>;
Expand description

Re-export of faer’s owned and borrowed matrix/column types.

Pls1Model, FindKOptimalOutput, and FindKSequenceOutput expose Mat<f64> / Col<f64> fields directly — keeping the canonical faer representation avoids round-trip allocations for Rust callers, who typically want to pass these straight back into linear-algebra code. Downstream users can use plskit::{Mat, Col} instead of adding faer to their Cargo.toml. The R, Python, and Julia wrappers translate these types to their host array representations at the FFI seam; see docs/rust/api.md. immutable view over a matrix, similar to an immutable reference to a 2d strided slice

§Note

unlike a slice, the data pointed to by MatRef<'_, T> is allowed to be partially or fully uninitialized under certain conditions. in this case, care must be taken to not perform any operations that read the uninitialized values, either directly or indirectly through any of the numerical library routines, unless it is explicitly permitted

Aliased Type§

#[repr(transparent)]
pub struct MatRef<'a, T, Rows = usize, Cols = usize, RStride = isize, CStride = isize>(pub Ref<'a, T, Rows, Cols, RStride, CStride>);

Tuple Fields§

§0: Ref<'a, T, Rows, Cols, RStride, CStride>