Skip to main content

ArpackStorage

Struct ArpackStorage 

Source
pub struct ArpackStorage { /* private fields */ }
Expand description

Preallocated working memory for repeated ARPACK runs (igraph_arpack_storage_t), freed on drop (igraph_arpack_storage_destroy).

Pass it to arpack_rssolve/arpack_rnsolve to avoid reallocating the workspace for every eigenproblem of order at most maxn using at most maxncv Lanczos/Arnoldi vectors (remember that ncv = 0 lets igraph pick a value up to n).

Binds igraph_arpack_storage_init.

Implementations§

Source§

impl ArpackStorage

Source

pub fn new(maxn: usize, maxncv: usize, symmetric: bool) -> Result<Self>

Allocates storage for problems of order at most maxn, with at most maxncv Lanczos/Arnoldi vectors; symmetric selects the layout for arpack_rssolve (true) or arpack_rnsolve (false; such a storage also works for symmetric problems).

Source

pub fn maxn(&self) -> usize

Maximum order of the problems.

Source

pub fn maxncv(&self) -> usize

Maximum number of Lanczos/Arnoldi vectors.

Source

pub fn is_symmetric(&self) -> bool

Whether the storage was allocated for symmetric problems only.

Trait Implementations§

Source§

impl Debug for ArpackStorage

Source§

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

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

impl Drop for ArpackStorage

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for ArpackStorage

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

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

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

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.