Struct SvdOptions 

pub struct SvdOptions {
    pub gauge: SvdGauge,
    pub derivative_eps: f64,
}

Options for singular value decomposition.

Examples

use tenferro_linalg::{SvdGauge, SvdOptions};

let options = SvdOptions::default()
    .gauge(SvdGauge::CanonicalPivot)
    .derivative_eps(1.0e-10);
assert_eq!(options.gauge, SvdGauge::CanonicalPivot);
assert_eq!(options.derivative_eps, 1.0e-10);

Fields

gauge: SvdGauge

Singular-vector gauge convention.

derivative_eps: f64

AD derivative regularization for repeated or nearly repeated singular values.

Implementations

impl SvdOptions

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

Return options with the requested singular-vector gauge.

Examples

use tenferro_linalg::{SvdGauge, SvdOptions};

let options = SvdOptions::default().gauge(SvdGauge::CanonicalPivot);
assert_eq!(options.gauge, SvdGauge::CanonicalPivot);

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

Return options with an explicit derivative epsilon.

Examples

use tenferro_linalg::SvdOptions;

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

Trait Implementations

impl Clone for SvdOptions

fn clone(&self) -> SvdOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SvdOptions

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

Formats the value using the given formatter.

impl Default for SvdOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SvdOptions

fn eq(&self, other: &SvdOptions) -> 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 SvdOptions

impl StructuralPartialEq for SvdOptions