Skip to main content

EighDriver

Enum EighDriver 

Source
pub enum EighDriver {
    Auto,
    Syevd,
    Syevj,
}
Expand description

cuSOLVER Hermitian eigensolver selection used by EighOptions on the CUDA backend.

The driver changes speed and rounding, not the decomposition contract, so gauges and AD rules are unaffected. CPU providers have a single eigh kernel and ignore it. Analogous to SvdDriver and to scipy.linalg.eigh(..., driver=...).

§Examples

use tenferro_linalg::{EighDriver, EighOptions};

let options = EighOptions::default().driver(EighDriver::Syevj);
assert_eq!(options.driver, EighDriver::Syevj);
assert_eq!(EighOptions::default().driver, EighDriver::Auto);

Variants§

§

Auto

The backend’s default policy: the fastest divide-and-conquer routine available. On CUDA a single matrix uses syevd/heevd and a batch uses cusolverDnXsyevBatched, which solves the whole batch in one launch at the same accuracy. On an A100 that is about 100x to 280x faster than the per-matrix loop this default used before.

The batched routine is a different cuSOLVER entry point, so batched results can differ from the per-matrix loop in the last ULPs.

§

Syevd

cuSOLVER’s divide-and-conquer driver, which is what Self::Auto already selects. Kept as an explicit spelling of the same choice.

§

Syevj

cuSOLVER’s Jacobi driver (cusolverDn<t>syevj, heevj for complex input, and their batched forms).

Worth asking for only on batches of small matrices: measured on an A100 it is slightly ahead of the default up to about order 32 and loses from there, by about 4x at order 128 and far more on wide spectra, where it is also the less accurate of the two.

Trait Implementations§

Source§

impl Clone for EighDriver

Source§

fn clone(&self) -> EighDriver

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EighDriver

Source§

impl Debug for EighDriver

Source§

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

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

impl Default for EighDriver

Source§

fn default() -> EighDriver

Returns the “default value” for a type. Read more
Source§

impl Eq for EighDriver

Source§

impl PartialEq for EighDriver

Source§

fn eq(&self, other: &EighDriver) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EighDriver

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
§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T
where T: Send + Sync,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.