Struct CooGradient 

pub struct CooGradient { /* private fields */ }

Sparse gradient for a 1-D dense parameter / embedding-row view, stored as a coordinate list (COO).

The representation is kept canonical: indices is strictly ascending, so the entries are sorted and free of duplicates, and every index is < dim.

Implementations

impl CooGradient

pub fn new( indices: Vec<usize>, values: Vec<f64>, dim: usize, ) -> Result<Self, GpuOptimError>

Build a canonical COO gradient from already sorted, unique indices.

Errors

Returns GpuOptimError::InvalidState when indices and values have mismatched lengths or when indices is not strictly ascending, and GpuOptimError::DimensionMismatch when any index is >= dim.

pub fn new_unsorted( indices: Vec<usize>, values: Vec<f64>, dim: usize, ) -> Result<Self, GpuOptimError>

Build a COO gradient from arbitrary (possibly unsorted, possibly duplicated) coordinate/value pairs.

Duplicate indices are accumulated (their gradient values are summed), which matches the semantics of looking up the same embedding row multiple times within one mini-batch. The result is canonicalized to strictly ascending indices.

Errors

Returns an error when lengths mismatch or when any index is >= dim.

pub fn empty(dim: usize) -> Self

Create an empty (all-zero) sparse gradient of dimension dim.

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

Validate the structural invariants: matching lengths, strictly ascending indices and in-bounds indices.

Errors

See CooGradient::new.

pub fn dim(&self) -> usize

Logical dimension of the dense vector.

pub fn nnz(&self) -> usize

Number of stored (non-zero) coordinates.

pub fn is_empty(&self) -> bool

True when no coordinate is touched.

pub fn indices(&self) -> &[usize]

Touched coordinate indices (strictly ascending).

pub fn values(&self) -> &[f64]

Gradient values (parallel to CooGradient::indices).

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

Iterate over (index, value) pairs.

Trait Implementations

impl Clone for CooGradient

fn clone(&self) -> CooGradient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CooGradient

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 CooGradient

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CooGradient