Skip to main content

SyevjInfo

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 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 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

Trait Implementations§

Source§

impl Debug for SyevjInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for SyevjInfo

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more
Source§

impl Send for SyevjInfo

Source§

impl Sync for SyevjInfo

Auto Trait Implementations§

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.