Struct SyevjInfo

Source

pub struct SyevjInfo { /* private fields */ }

Implementations§

Source §

impl SyevjInfo

Source

pub fn create() -> Result<Self>

Creates syevj, syevj_batched, and sygvj parameter storage with default values.

The returned SyevjInfo owns the cuSOLVER parameter handle and destroys it when dropped.

§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 syevj tolerance.

§Errors

Returns an error if cuSOLVER rejects the tolerance value.

Source

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

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

§Errors

Returns an error if cuSOLVER rejects the sweep count.

Source

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

If sort_eigenvalues is false, the eigenvalues are not sorted. This setting only applies to syevj_batched. syevj and sygvj always sort eigenvalues in ascending order. By default, eigenvalues are always sorted in ascending order.

§Errors

Returns an error if cuSOLVER rejects the sort setting.

Source

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

Returns the residual reported by syevj or sygvj. This accessor does not support syevj_batched. Calling this after syevj_batched returns crate::error::Status::NotSupported.

§Errors

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

Source

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

Returns the number of executed syevj or sygvj sweeps. This accessor does not support syevj_batched. Calling this after syevj_batched returns crate::error::Status::NotSupported.

§Errors

Returns an error if the info handle was used with syevj_batched, which does not report a sweep count.

Source

pub fn as_raw(&self) -> syevjInfo_t

Source

pub unsafe fn from_raw(handle: syevjInfo_t) -> Result<Self>

Takes ownership of a raw cuSOLVER syevj info handle.

§Safety

handle must be a valid syevjInfo_t created by cuSOLVER. The returned wrapper takes ownership and will destroy it with cusolverDnDestroySyevjInfo; no other owner may destroy or keep using it.

Source