pub struct EigshWorkspace { /* private fields */ }Expand description
Reusable state for a sequence of related Hermitian eigenproblems.
The workspace keeps the complete converged invariant subspace from the
previous solve. eigsh_with_workspace preserves it as a thick initial
subspace for restarted windows and combines all of its vectors into a
balanced warm start when the cheaper tridiagonal Lanczos path applies.
Implementations§
Source§impl EigshWorkspace
impl EigshWorkspace
Sourcepub const fn dimension(&self) -> usize
pub const fn dimension(&self) -> usize
Return the operator dimension associated with the stored subspace.
Sourcepub fn initial_subspace(&self) -> &[Vec<Complex64>]
pub fn initial_subspace(&self) -> &[Vec<Complex64>]
Borrow the complete converged subspace from the previous solve.
Sourcepub fn set_initial_subspace(
&mut self,
dimension: usize,
vectors: impl IntoIterator<Item = Vec<Complex64>>,
) -> Result<()>
pub fn set_initial_subspace( &mut self, dimension: usize, vectors: impl IntoIterator<Item = Vec<Complex64>>, ) -> Result<()>
Install a user-provided warm-start subspace after validating dimensions.
Trait Implementations§
Source§impl Clone for EigshWorkspace
impl Clone for EigshWorkspace
Source§fn clone(&self) -> EigshWorkspace
fn clone(&self) -> EigshWorkspace
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for EigshWorkspace
impl Debug for EigshWorkspace
Source§impl Default for EigshWorkspace
impl Default for EigshWorkspace
Source§fn default() -> EigshWorkspace
fn default() -> EigshWorkspace
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for EigshWorkspace
impl RefUnwindSafe for EigshWorkspace
impl Send for EigshWorkspace
impl Sync for EigshWorkspace
impl Unpin for EigshWorkspace
impl UnsafeUnpin for EigshWorkspace
impl UnwindSafe for EigshWorkspace
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
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
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.