Skip to main content

SvdDriver

Enum SvdDriver 

Source
pub enum SvdDriver {
    Auto,
    Jacobi,
    QrBased,
    Polar,
}
Expand description

Algorithm family used by SvdOptions.

A provider may ignore the selection and run its single SVD kernel; where a selection is honoured it changes speed and numerical behavior, not the decomposition contract, so gauge handling and AD rule selection are unaffected. Self::Polar may perturb near-singular inputs. Equivalent to jax.lax.linalg.svd(..., algorithm=...) and torch.linalg.svd(..., driver=...).

§Examples

use tenferro_linalg::{SvdDriver, SvdOptions};

let options = SvdOptions::default().driver(SvdDriver::QrBased);
assert_eq!(options.driver, SvdDriver::QrBased);
assert_eq!(SvdOptions::default().driver, SvdDriver::Auto);

Variants§

§

Auto

The provider’s default policy for this input.

Never selects Self::Polar: its small singular values are only accurate to about 1e-6 of the largest, which an eps-scale truncation cannot tolerate, so the accurate families stay the default unless the caller opts in. A provider with one SVD kernel returns the same factors for every selection.

On the CUDA provider this is the accuracy-preserving, JAX-compatible rule: Self::Jacobi when both matrix dimensions are at most 1024, otherwise Self::QrBased.

§

Jacobi

One-sided Jacobi rotations: the accurate family for small and medium orders, and more work than Self::QrBased on large or wide spectra. On the CUDA provider this selects cusolverDn<t>gesvdj.

§

QrBased

Bidiagonalization followed by an implicit-QR iteration: the general purpose family, and the faster of the two accurate families on large and wide spectra. On the CUDA provider this selects cusolverDn<t>gesvd.

§

Polar

Polar decomposition: the fastest family for min(m, n) >= 256 on an A100 (see the cuda_svd_driver benchmark), and the least accurate on small singular values.

Explicit only: Self::Auto never selects it. Its small singular values are only accurate to about 1e-6 of the largest, so do not use it for an eps-scale truncation (a pseudoinverse or a tensor-network truncation at 1e-12..1e-14): the perturbation can change the retained rank. Accuracy is input-dependent rather than uniformly worse than Self::QrBased: on ten-decade spectra built as U diag(s) Vᴴ it was the most accurate of the three families on an A100, but on a circulant-like matrix with the same spectrum it lost about two digits against Self::QrBased. Measure on your own inputs before relying on it for small singular values.

A provider that can bound its own perturbation returns a typed backend failure instead of silently wrong factors when the bound is not small relative to the largest singular value. On the CUDA provider this selects cusolverDnXgesvdp.

Trait Implementations§

Source§

impl Clone for SvdDriver

Source§

fn clone(&self) -> Self

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 SvdDriver

Source§

impl Debug for SvdDriver

Source§

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

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

impl Default for SvdDriver

Source§

fn default() -> Self

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

impl Eq for SvdDriver

Source§

impl PartialEq for SvdDriver

Source§

fn eq(&self, other: &Self) -> 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 SvdDriver

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

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.