Struct SparseVectorDescriptor 

pub struct SparseVectorDescriptor<'a> { /* private fields */ }

Implementations

impl<'a> SparseVectorDescriptor<'a>

pub fn create<I: IndexTypeLike, T: DataTypeLike>( ctx: &Context, size: usize, nonzero_count: usize, indices: &'a mut DeviceMemory<I>, values: &'a mut DeviceMemory<T>, index_base: IndexBase, ) -> Result<Self>

Initializes a sparse vector descriptor.

The descriptor borrows the device index and value buffers by pointer; the buffers must outlive descriptor use or be replaced with SparseVectorDescriptor::set_values.

pub fn index_base(&self) -> Result<IndexBase>

Returns the index base of this sparse vector descriptor.

Errors

Returns an error if cuSPARSE cannot report the sparse vector index base.

pub fn values(&self) -> Result<DevicePtr>

Returns the values pointer of this sparse vector descriptor.

Errors

Returns an error if cuSPARSE cannot report the values pointer.

pub fn set_values<T: DataTypeLike>( &mut self, values: &'a mut DeviceMemory<T>, ) -> Result<()>

Sets the values pointer of this sparse vector descriptor.

The pointed-to device buffer must remain valid while the descriptor uses it.

Errors

Returns an error if cuSPARSE rejects the values pointer.

pub fn info(&self) -> Result<SparseVectorInfo>

Returns the fields of this sparse vector descriptor.

Errors

Returns an error if cuSPARSE cannot report the descriptor fields or if reported sizes cannot be represented as usize.

pub fn as_raw(&self) -> cusparseSpVecDescr_t

pub fn as_raw_const(&self) -> cusparseConstSpVecDescr_t

pub fn cuda_context(&self) -> &Arc<CudaContext>

pub unsafe fn from_raw( handle: cusparseSpVecDescr_t, ctx: &Context, ) -> Result<Self>

Wraps an existing cuSPARSE sparse-vector descriptor and takes ownership of it.

Safety

handle must be a valid cusparseSpVecDescr_t. Any device buffers referenced by the descriptor must remain valid for lifetime 'a. Ownership of handle is transferred to the returned descriptor, and the handle must not be destroyed elsewhere after calling this function.

pub fn into_raw(self) -> cusparseSpVecDescr_t

Consumes the descriptor and returns the raw cuSPARSE handle without destroying it.

The caller becomes responsible for eventually destroying the returned handle with cusparseDestroySpVec.

Trait Implementations

impl<'a> Debug for SparseVectorDescriptor<'a>

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

Formats the value using the given formatter.

impl Drop for SparseVectorDescriptor<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for SparseVectorDescriptor<'_>