Skip to main content

QrSolver

kryst::solver::direct_lu

Struct QrSolver

pub struct QrSolver;

Available on crate feature backend-faer only.

Expand description

QR solver using Faer (for square or rectangular systems).

Implementations§

impl QrSolver

pub fn new() -> Self

Create a new QR solver.

Trait Implementations§

impl Default for QrSolver

fn default() -> Self

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

impl LinearSolver<Mat<Own<f64>>, Vec<f64>> for QrSolver

fn solve( &mut self, a: &Mat<f64>, pc: Option<&(dyn Preconditioner<Mat<f64>, Vec<f64>> + '_)>, b: &Vec<f64>, x: &mut Vec<f64>, _pc_side: PcSide, _comm: &UniverseComm, monitors: Option<&[Box<MonitorCallback<Self::Scalar>>]>, _work: Option<&mut Workspace>, ) -> Result<SolveStats<f64>, KError>

Solve Ax = b using QR factorization.

§Arguments

a - Matrix (Faer Mat)
pc - (Unused) Preconditioner (not supported for direct solvers)
b - Right-hand side vector
x - On input: ignored; on output: solution vector
comm - Communicator for parallel operations (unused for direct solvers)
monitors - Optional callbacks to invoke at each iteration
work - Optional workspace (unused for direct solvers)

§Returns

Ok(SolveStats) (always converged in 1 iteration)

type Error = KError

type Scalar = f64

fn setup_workspace(&mut self, _work: &mut Workspace)

fn solve_simple( &mut self, a: &M, pc: Option<&(dyn Preconditioner<M, V> + '_)>, b: &V, x: &mut V, pc_side: PcSide, comm: &UniverseComm, ) -> Result<SolveStats<Self::Scalar>, Self::Error>
where Self: Sized,

fn solve_with_monitors( &mut self, a: &M, pc: Option<&(dyn Preconditioner<M, V> + '_)>, b: &V, x: &mut V, pc_side: PcSide, comm: &UniverseComm, monitors: &[Box<MonitorCallback<Self::Scalar>>], ) -> Result<SolveStats<Self::Scalar>, Self::Error>
where Self: Sized,

fn solve_with_workspace( &mut self, a: &M, pc: Option<&(dyn Preconditioner<M, V> + '_)>, b: &V, x: &mut V, pc_side: PcSide, comm: &UniverseComm, work: &mut Workspace, ) -> Result<SolveStats<Self::Scalar>, Self::Error>
where Self: Sized,

Auto Trait Implementations§

impl Freeze for QrSolver

impl RefUnwindSafe for QrSolver

impl Send for QrSolver

impl Sync for QrSolver

impl Unpin for QrSolver

impl UnsafeUnpin for QrSolver

impl UnwindSafe for QrSolver

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src
where Scheme: ApproxScheme,

type Err = NoError

The error type produced by a failed conversion.

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Convert the given value into an approximately equivalent representation.

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src
where Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Convert the subject into an approximately equivalent representation.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

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

impl<T, Dst> ConvAsUtil<Dst> for T

fn approx(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Approximate the subject with the default scheme.

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Approximate the subject with a specific scheme.

impl<T> ConvUtil for T

fn approx_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Approximate the subject to a given type with the default scheme.

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Approximate the subject to a given type with a specific scheme.

fn into_as<Dst>(self) -> Dst
where Self: Sized + Into<Dst>,

Convert the subject to a given type.

fn try_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + TryInto<Dst>,

Attempt to convert the subject to a given type.

fn value_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ValueInto<Dst>,

Attempt a value conversion of the subject to a given type.

impl<T> DistributionExt for T
where T: ?Sized,

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

type Output = T

Should always be Self

impl<T> ShellContext for T
where T: Send + Sync + Any,

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<Src> TryFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Convert the given value into the subject type.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<Src, Dst> TryInto<Dst> for Src
where Dst: TryFrom<Src>,

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Convert the subject into the destination type.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<Src> ValueFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Convert the given value into an exactly equivalent representation.

impl<Src, Dst> ValueInto<Dst> for Src
where Dst: ValueFrom<Src>,

type Err = <Dst as ValueFrom<Src>>::Err

The error type produced by a failed conversion.

fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Convert the subject into an exactly equivalent representation.