Struct GesvdjInfo

Source

pub struct GesvdjInfo { /* private fields */ }

Implementations§

Source §

impl GesvdjInfo

Source

pub fn create() -> Result<Self>

Creates gesvdj and gesvdjBatched parameter storage with default values.

§Errors

Returns an error if cuSOLVER cannot allocate the parameter storage or if it does not return a valid handle.

Source

pub fn set_tolerance(&mut self, tolerance: f64) -> Result<()>

Configures the gesvdj tolerance.

§Errors

Returns an error if cuSOLVER rejects tolerance.

Source

pub fn set_max_sweeps(&mut self, max_sweeps: i32) -> Result<()>

Configures the maximum number of gesvdj sweeps. The default value is 100.

§Errors

Returns an error if cuSOLVER rejects max_sweeps.

Source

pub fn set_sort_eigenvalues(&mut self, sort_eigenvalues: bool) -> Result<()>

If sort_eigenvalues is false, the singular values are not sorted. This setting only applies to gesvdjBatched. gesvdj always sorts singular values in descending order. By default, singular values are always sorted in descending order.

§Errors

Returns an error if cuSOLVER rejects the sort setting.

Source

pub fn residual(&self, ctx: &Context) -> Result<f64>

Returns the Frobenius norm of the internal residual reported by gesvdj. Not the Frobenius norm of the exact residual.

This accessor does not support gesvdjBatched. Calling this after gesvdjBatched returns Status::NotSupported.

§Errors

Returns an error if the info handle was used with gesvdjBatched, which does not report a residual.

Source

pub fn executed_sweeps(&self, ctx: &Context) -> Result<i32>

Returns the number of executed gesvdj sweeps. This accessor does not support gesvdjBatched. Calling this after gesvdjBatched returns Status::NotSupported.