Skip to main content

SolverSelection

Enum SolverSelection 

Source
pub enum SolverSelection {
    Auto,
    Named(String),
}
Expand description

How a linear solver is chosen for a system.

§Canonical solver names

Named carries one of the registered backend names below. Unknown names are rejected with a structured SolverError — they never fall back.

namesymmetrydefinitenessintended sizeregistered by default
denseany (general)anysmallyes
skyline_ldltsymmetric onlySPD (verified)medium/largeyes
sparse_luany (general)anymedium/largeyes
cgsymmetric onlySPD (assumed)largeyes
iccgsymmetric onlySPD (assumed)largeyes

§Semantics

  • Auto: the registry analyses the matrix and picks a backend. It may substitute a different backend than any the caller had in mind.
  • Named: the request is authoritative. The registry validates capabilities and returns an error if the backend cannot legally handle the matrix. It never substitutes another backend.

skyline_ldlt, cg and iccg require positive definiteness but perform their own definiteness check during LinearSolver::factor (skyline rejects a non-positive pivot; CG/ICCG report failure). They are therefore safe to select on a symmetric matrix, but are never chosen by Auto for a matrix whose SPD property is not established.

Variants§

§

Auto

Registry-based automatic selection (default).

§

Named(String)

Explicit backend request (canonical name, see type docs).

Implementations§

Source§

impl SolverSelection

Source

pub fn named(name: impl Into<String>) -> Self

Explicit selection by canonical name.

Source

pub fn dense() -> Self

Select the dense Gaussian backend.

Source

pub fn skyline_ldlt() -> Self

Select the skyline LDL^T backend (symmetric SPD).

Source

pub fn sparse_lu() -> Self

Select the sparse LU backend.

Source

pub fn cg() -> Self

Select the conjugate-gradient backend (symmetric SPD).

Source

pub fn iccg() -> Self

Select the incomplete-Cholesky CG backend (symmetric SPD).

Source

pub fn is_auto(&self) -> bool

Whether this is automatic selection.

Source

pub fn requested_name(&self) -> Option<&str>

The explicitly requested name, or None for SolverSelection::Auto.

Trait Implementations§

Source§

impl Clone for SolverSelection

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 Debug for SolverSelection

Source§

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

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

impl Default for SolverSelection

Source§

fn default() -> Self

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

impl Eq for SolverSelection

Source§

impl PartialEq for SolverSelection

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 SolverSelection

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