Struct StackedLayout 

pub struct StackedLayout {
    pub sorted_cols: Vec<(usize, usize, StackedSlice)>,
    pub mat_starts: Vec<usize>,
    /* private fields */
}

Fields

sorted_cols: Vec<(usize, usize, StackedSlice)>

The columns of the unstacked matrices in sorted order. Each entry (matrix index, column index, coordinate) contains the pointer (matrix index, column index) to a column of the unstacked collection of matrices as well as coordinate which is a pointer to where the column starts in the stacked matrix.

mat_starts: Vec<usize>

mat_starts[mat_idx] is the index in sorted_cols where the matrix with index mat_idx starts.

Implementations

impl StackedLayout

pub fn l_skip(&self) -> usize

The minimum log2 height of a stacked slice. When stacking columns with smaller height, the column is expanded to 2^l_skip by striding.

pub fn height(&self) -> usize

Stacked height

pub fn width(&self) -> usize

Stacked width

impl StackedLayout

pub fn new( l_skip: usize, log_stacked_height: usize, sorted: Vec<(usize, usize)>, ) -> Result<Self, StackedPcsError>

Computes the layout of greedily stacking columns with dimension metadata given by sorted into a stacked matrix.

• l_skip is a threshold log2 height: if a column has height less than 2^l_skip, it is stacked as a column of height 2^l_skip with stride 2^{l_skip - log_height}.
• log_stacked_height is the log2 height of the stacked matrix.
• sorted is Vec of (width, log_height) that must already be sorted in descending order of log_height.

pub fn from_raw_parts( l_skip: usize, log_stacked_height: usize, sorted_cols: Vec<(usize, usize, StackedSlice)>, ) -> Result<Self, StackedPcsError>

Raw unsafe constructor

pub fn unstacked_slices_iter(&self) -> impl Iterator<Item = &StackedSlice>

pub fn get(&self, mat_idx: usize, col_idx: usize) -> Option<&StackedSlice>

(mat_idx, col_idx) should be indexing into the unstacked collection of matrices.

pub fn width_of(&self, mat_idx: usize) -> usize

pub fn mat_view<'a, F>( &self, unstacked_mat_idx: usize, stacked_matrix: &'a ColMajorMatrix<F>, ) -> StridedColMajorMatrixView<'a, F>

Due to the definition of stacking, in a column major matrix the lifted columns of the unstacked matrix will always be contiguous in memory within the stacked matrix, so we can return the sub-view.

Trait Implementations

impl Clone for StackedLayout

fn clone(&self) -> StackedLayout

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StackedLayout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StackedLayout

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StackedLayout

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.