Struct RankRevealingQrOptions 

pub struct RankRevealingQrOptions {
    pub gauge: QrGauge,
    pub rtol: f64,
    pub atol: f64,
}

Options for column-pivoted rank-revealing QR.

Rank is the length of the leading diagonal prefix satisfying abs(R[i,i]) > max(atol, rtol * abs(R[0,0])). Both tolerances must be finite and non-negative. The default uses zero tolerances so callers choose an application-specific numerical threshold explicitly.

Examples

use tenferro_linalg::{QrGauge, RankRevealingQrOptions};

let options = RankRevealingQrOptions::default()
    .gauge(QrGauge::PositiveDiagonal)
    .rtol(1.0e-10)
    .atol(1.0e-14);
assert_eq!(options.rtol, 1.0e-10);
assert_eq!(options.atol, 1.0e-14);

Fields

gauge: QrGauge

QR sign or phase convention. The default is QrGauge::Raw.

rtol: f64

Relative diagonal threshold. The default is 0.0.

atol: f64

Absolute diagonal threshold. The default is 0.0.

Implementations

impl RankRevealingQrOptions

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

Return options with the requested QR gauge.

Examples

use tenferro_linalg::{QrGauge, RankRevealingQrOptions};

let options = RankRevealingQrOptions::default().gauge(QrGauge::PositiveDiagonal);
assert_eq!(options.gauge, QrGauge::PositiveDiagonal);

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

Return options with the requested relative rank tolerance.

Examples

use tenferro_linalg::RankRevealingQrOptions;

let options = RankRevealingQrOptions::default().rtol(1.0e-8);
assert_eq!(options.rtol, 1.0e-8);

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

Return options with the requested absolute rank tolerance.

Examples

use tenferro_linalg::RankRevealingQrOptions;

let options = RankRevealingQrOptions::default().atol(1.0e-12);
assert_eq!(options.atol, 1.0e-12);

Trait Implementations

impl Clone for RankRevealingQrOptions

fn clone(&self) -> RankRevealingQrOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RankRevealingQrOptions

impl Debug for RankRevealingQrOptions

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

Formats the value using the given formatter.

impl Default for RankRevealingQrOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RankRevealingQrOptions

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