Struct CsrGradient 

pub struct CsrGradient { /* private fields */ }

Sparse gradient for a 2-D embedding table, stored in compressed sparse row (CSR) form.

Invariants (checked by CsrGradient::validate):

• row_offsets.len() == shape.0 + 1, row_offsets[0] == 0, monotonically non-decreasing, and row_offsets[shape.0] == col_indices.len().
• col_indices.len() == values.len().
• within every row the column indices are strictly ascending and < shape.1.

Implementations

impl CsrGradient

pub fn new( row_offsets: Vec<usize>, col_indices: Vec<usize>, values: Vec<f64>, shape: (usize, usize), ) -> Result<Self, GpuOptimError>

Build a CSR gradient and validate it.

Errors

Returns GpuOptimError::InvalidState / GpuOptimError::DimensionMismatch when any structural invariant is violated.

pub fn empty(shape: (usize, usize)) -> Self

Create an empty (all-zero) CSR gradient of the given shape.

pub fn validate(&self) -> Result<(), GpuOptimError>

Validate all CSR structural invariants.

Errors

See the type-level documentation for the checked invariants.

pub fn shape(&self) -> (usize, usize)

Dense shape (rows, cols).

pub fn rows(&self) -> usize

Number of rows in the dense table.

pub fn cols(&self) -> usize

Number of columns in the dense table.

pub fn nnz(&self) -> usize

Number of stored (non-zero) entries.

pub fn row(&self, r: usize) -> Result<(&[usize], &[f64]), GpuOptimError>

Column indices and values stored for row r.

Errors

Returns GpuOptimError::DimensionMismatch when r is out of range.

pub fn iter(&self) -> impl Iterator<Item = (usize, usize, f64)> + '_

Iterate over (row, col, value) triplets in row-major (and within a row, column-ascending) order.

pub fn to_coo(&self) -> CooGradient

Convert to a flattened 1-D CooGradient using linear indices row * cols + col over a rows * cols view. The resulting indices are globally ascending, so the COO gradient is already canonical.

pub fn from_coo( coo: &CooGradient, shape: (usize, usize), ) -> Result<Self, GpuOptimError>

Build a CSR gradient from a flattened 1-D CooGradient of dimension shape.0 * shape.1, decoding each linear index into (row, col).

Errors

Returns GpuOptimError::DimensionMismatch when coo.dim() does not equal shape.0 * shape.1, or GpuOptimError::InvalidState when the table would have zero columns while carrying entries.

Trait Implementations

impl Clone for CsrGradient

fn clone(&self) -> CsrGradient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CsrGradient

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

Formats the value using the given formatter.

impl From<&CsrGradient> for CooGradient

fn from(csr: &CsrGradient) -> Self

Converts to this type from the input type.

impl PartialEq for CsrGradient

fn eq(&self, other: &CsrGradient) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CsrGradient