Skip to main content

SymShiftInvert

Struct SymShiftInvert 

Source
pub struct SymShiftInvert<T: Real = f64, K: DenseKernel<T> = NaiveDense> {
    sigma: T,
    n: usize,
    below: usize,
    ldl: SupernodalLdl<T, K>,
    num: NumericLdl<T>,
    low: CscMatrix<T>,
    r: Vec<T>,
}
Expand description

x ↦ (A − σI)⁻¹ x for a symmetric sparse A (lower triangle read), by SupernodalLdl<T, K> with no regularization; the inertia of A − σI is kept: by Sylvester’s law it counts the eigenvalues below σ (SymShiftInvert::count_below) — a check ARPACK does not offer. Each application refines once (Algorithm R: two solves and one product with the kept lower triangle of A − σI). The operator of eigsh_near (Algorithm SI of Chapter 12.6.2).

Fields§

§sigma: T§n: usize§below: usize§ldl: SupernodalLdl<T, K>§num: NumericLdl<T>§low: CscMatrix<T>

The lower triangle of M = A − σI (Algorithm R).

§r: Vec<T>

The residual r of step R2.

Implementations§

Source§

impl<T: Real, K: DenseKernel<T>> SymShiftInvert<T, K>

Source

pub fn new(a: &CscMatrix<T>, sigma: T, kernel: K) -> Result<Self, StatlaError>

Analyze (own AMD ordering) and factorize A − σI.

§Errors

StatlaError::InvalidArgument (not square), StatlaError::NonFinite (a, sigma), StatlaError::Kkt (a structurally invalid a; a zero pivot: σ is numerically an eigenvalue).

Source

pub fn sigma(&self) -> T

The shift.

Source

pub fn count_below(&self) -> usize

Number of eigenvalues of A strictly below σ (negative inertia of A − σI).

Trait Implementations§

Source§

impl<T: Debug + Real, K: Debug + DenseKernel<T>> Debug for SymShiftInvert<T, K>

Source§

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

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

impl<T: Real, K: DenseKernel<T>> LinearOperator<T> for SymShiftInvert<T, K>

Source§

fn nrows(&self) -> usize

Rows of A (length of y).
Source§

fn ncols(&self) -> usize

Columns of A (length of x).
Source§

fn apply(&mut self, x: &[T], y: &mut [T]) -> Result<(), OperatorError>

y ← A x. Read more
Source§

fn apply_block( &mut self, x: MatRef<'_, T>, y: MatMut<'_, T>, ) -> Result<(), OperatorError>

Y ← A X for a block of columns; the default loops over LinearOperator::apply. Dense and sparse implementations override it (one pass over A for l columns — the cost that matters in crate::rsvd()). Read more

Auto Trait Implementations§

§

impl<T = f64, K = NaiveDense> !Freeze for SymShiftInvert<T, K>

§

impl<T, K> RefUnwindSafe for SymShiftInvert<T, K>

§

impl<T, K> Send for SymShiftInvert<T, K>
where T: Send, K: Send,

§

impl<T, K> Sync for SymShiftInvert<T, K>
where T: Sync + Send, K: Sync,

§

impl<T, K> Unpin for SymShiftInvert<T, K>
where T: Unpin, K: Unpin,

§

impl<T, K> UnsafeUnpin for SymShiftInvert<T, K>
where T: UnsafeUnpin, K: UnsafeUnpin,

§

impl<T, K> UnwindSafe for SymShiftInvert<T, K>
where T: UnwindSafe, K: UnwindSafe,

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

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.