Struct EighOptions 

#[non_exhaustive]
pub struct EighOptions {
    pub return_eigenvectors: bool,
}

Controls whether eigh_with_options retains the complete eigenvector matrix.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

return_eigenvectors: bool

Return eigenvectors when true; values and residuals are always returned.

Implementations

impl EighOptions

pub const fn new(return_eigenvectors: bool) -> Self

Construct controls which retain or discard the full eigenvector matrix.

pub const fn values_only() -> Self

Compute eigenvalues and residual evidence without returning vectors.

Trait Implementations

impl Clone for EighOptions

fn clone(&self) -> EighOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EighOptions

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

Formats the value using the given formatter.

impl Default for EighOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for EighOptions

fn eq(&self, other: &EighOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for EighOptions

impl Eq for EighOptions

impl StructuralPartialEq for EighOptions