Struct EighOptions 

pub struct EighOptions {
    pub gauge: EighGauge,
    pub derivative_eps: f64,
}

Options for Hermitian eigenvalue decomposition.

Examples

use tenferro_linalg::EighOptions;

let options = EighOptions::default().derivative_eps(1.0e-10);
assert_eq!(options.derivative_eps, 1.0e-10);

Fields

gauge: EighGauge

Eigenvector gauge convention.

derivative_eps: f64

AD derivative regularization for repeated or nearly repeated eigenvalues.

Implementations

impl EighOptions

pub fn gauge(self, gauge: EighGauge) -> Self

Return options with the requested eigenvector gauge.

Examples

use tenferro_linalg::{EighGauge, EighOptions};

let options = EighOptions::default().gauge(EighGauge::CanonicalPivot);
assert_eq!(options.gauge, EighGauge::CanonicalPivot);

pub fn derivative_eps(self, derivative_eps: f64) -> Self

Return options with an explicit derivative epsilon.

Examples

use tenferro_linalg::EighOptions;

let options = EighOptions::default().derivative_eps(1.0e-9);
assert_eq!(options.derivative_eps, 1.0e-9);

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 StructuralPartialEq for EighOptions