Skip to main content

CooMatrix

Struct CooMatrix 

Source
pub struct CooMatrix<T: GpuFloat> { /* private fields */ }
Expand description

A sparse matrix in Coordinate (COO) format, stored on GPU.

The matrix has shape (rows, cols) with nnz non-zero elements. Each non-zero is represented by its row index, column index, and value.

Implementations§

Source§

impl<T: GpuFloat> CooMatrix<T>

Source

pub fn from_host( rows: u32, cols: u32, row_idx: &[i32], col_idx: &[i32], values: &[T], ) -> SparseResult<Self>

Creates a COO matrix from host-side arrays, uploading to GPU.

The triplets are assumed to be unsorted unless the caller knows otherwise (use with_sorted to override).

§Arguments
  • rows – Number of rows.
  • cols – Number of columns.
  • row_idx – Row indices of length nnz.
  • col_idx – Column indices of length nnz.
  • values – Non-zero values of length nnz.
§Errors

Returns SparseError::InvalidFormat if array lengths are inconsistent.

Source

pub fn from_device( rows: u32, cols: u32, nnz: u32, row_idx: DeviceBuffer<i32>, col_idx: DeviceBuffer<i32>, values: DeviceBuffer<T>, ) -> SparseResult<Self>

Creates a COO matrix from pre-allocated device buffers.

This is the unchecked escape hatch: only buffer lengths are validated. The contents of row_idx/col_idx are not range checked against rows/cols. Passing indices outside [0, rows)/[0, cols) will cause out-of-bounds device memory access in downstream operations (e.g. to_csr, to_csc, or SpMV/SpMM kernels). Callers are responsible for ensuring indices are in range before calling this constructor; prefer from_host when the data originates on the host, as it validates the full range.

§Errors

Returns SparseError::InvalidFormat if buffer lengths are inconsistent.

Source

pub fn with_sorted(self, sorted: bool) -> Self

Mark the COO matrix as sorted by (row, col).

This is a hint for conversion routines; the caller is responsible for ensuring correctness.

Source

pub fn to_host(&self) -> SparseResult<(Vec<i32>, Vec<i32>, Vec<T>)>

Downloads the COO arrays from GPU to host memory.

§Errors

Returns SparseError::Cuda on transfer failure.

Source

pub fn to_csr(&self) -> SparseResult<CsrMatrix<T>>

Converts this COO matrix to CSR format.

Downloads to host, builds row pointers via histogram, then uploads.

§Errors

Returns SparseError::Cuda on transfer failure. Returns SparseError::InvalidFormat if any downloaded row or column index is out of range (this can happen for matrices constructed via the unchecked from_device constructor).

Source

pub fn to_csc(&self) -> SparseResult<CscMatrix<T>>

Converts this COO matrix to CSC format.

Downloads to host, builds column pointers, then uploads.

§Errors

Returns SparseError::Cuda on transfer failure. Returns SparseError::InvalidFormat if any downloaded row or column index is out of range (this can happen for matrices constructed via the unchecked from_device constructor).

Source

pub fn is_sorted(&self) -> bool

Returns whether the triplets are sorted by (row, col).

Source

pub fn rows(&self) -> u32

Returns the number of rows.

Source

pub fn cols(&self) -> u32

Returns the number of columns.

Source

pub fn nnz(&self) -> u32

Returns the number of non-zero elements.

Source

pub fn row_idx(&self) -> &DeviceBuffer<i32>

Returns a reference to the row index device buffer.

Source

pub fn col_idx(&self) -> &DeviceBuffer<i32>

Returns a reference to the column index device buffer.

Source

pub fn values(&self) -> &DeviceBuffer<T>

Returns a reference to the values device buffer.

Auto Trait Implementations§

§

impl<T> Freeze for CooMatrix<T>

§

impl<T> RefUnwindSafe for CooMatrix<T>
where T: RefUnwindSafe,

§

impl<T> Send for CooMatrix<T>

§

impl<T> Sync for CooMatrix<T>

§

impl<T> Unpin for CooMatrix<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for CooMatrix<T>

§

impl<T> UnwindSafe for CooMatrix<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more