Struct Potrf 

pub struct Potrf<T> { /* private fields */ }

Typed Cholesky factorization operation.

This is the preferred operation-family API for POTRF. It keeps matrix metadata grouped in MatrixRef and MatrixMut instead of exposing the cuSOLVER S/D/C/Z entry point names and separate a/lda arguments.

Implementations

impl<T> Potrf<T>

where T: DataTypeLike,

pub fn new(fill_mode: FillMode, n: usize) -> Self

Creates a typed POTRF operation using the matrix data type as compute type.

pub const fn with_compute_type(self, compute_type: DataType) -> Self

Sets the compute type passed to the generic cuSOLVER X API.

pub const fn fill_mode(&self) -> FillMode

Returns the cuSOLVER fill mode.

pub const fn n(&self) -> usize

Returns the square matrix dimension.

pub const fn compute_type(&self) -> DataType

Returns the cuSOLVER compute type.

pub fn workspace_size( &self, ctx: &Context, params: &Params, a: MatrixRef<'_, T>, ) -> Result<WorkspaceSizes>

Returns the required device and host workspace sizes.

Errors

Returns an error if the matrix shape is invalid or cuSOLVER cannot report the workspace sizes.

pub fn run( &self, ctx: &Context, params: &Params, args: PotrfArgs<'_, T>, ) -> Result<()>

Computes the Cholesky factorization in place.

Errors

Returns an error if inputs or workspaces are invalid, or if cuSOLVER reports a failure.

Trait Implementations

impl<T: Clone> Clone for Potrf<T>

fn clone(&self) -> Potrf<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Potrf<T>

impl<T: Debug> Debug for Potrf<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Potrf<T>

impl<T: PartialEq> PartialEq for Potrf<T>

fn eq(&self, other: &Potrf<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialEq> StructuralPartialEq for Potrf<T>