Skip to main content

Scaling

Struct Scaling 

Source
pub struct Scaling<T: Real = f64> {
    pub row: Vec<T>,
    pub col: Vec<T>,
}
Expand description

Row and column factors: A' = diag(row) · A · diag(col) (invariants (S8), (S9)).

Fields§

§row: Vec<T>

r_i, one per row.

§col: Vec<T>

c_j, one per column.

Implementations§

Source§

impl<T: Real> Scaling<T>

Source

pub fn compute(a: &CscMatrix<T>, policy: Equilibration) -> Self

The factors of a under policy (Algorithms G, R, I).

use xingo_sparse::{CscMatrix, Col, Equilibration, Row, Scaling};
let a = CscMatrix::from_triplets(2, 2, &[
    (Row(0), Col(0), 1e-3), (Row(1), Col(0), 4.0), (Row(1), Col(1), 1e3),
])
.unwrap();
let policy = Equilibration::Geometric { max_iters: 4, power_of_two: true };
let s = Scaling::compute(&a, policy);
assert!(s.spread(&a) < 1e6); // the spread of `a` itself is 1e3 / 1e-3
let mut b = a.clone();
s.apply(&mut b);
s.unapply(&mut b);
assert_eq!(a, b); // (S8): powers of two round-trip exactly
Source

pub fn apply(&self, a: &mut CscMatrix<T>)

A ← diag(row) · A · diag(col) in place.

§Panics

If the factor lengths do not match the dimensions of a.

Source

pub fn unapply(&self, a: &mut CscMatrix<T>)

A ← diag(row)⁻¹ · A · diag(col)⁻¹ in place: the inverse of Scaling::apply, exactly so for powers of two ((S8)).

§Panics

If the factor lengths do not match the dimensions of a.

Source

pub fn spread(&self, a: &CscMatrix<T>) -> T

The spread max|a'| / min|a'| over the nonzeros of the scaled matrix a' = diag(row) · a · diag(col) (a itself is not modified); one when a has no nonzeros.

§Panics

If the factor lengths do not match the dimensions of a.

Source

pub fn check_invariants(&self) -> Result<(), SparseError>

Checks (S9): every factor finite and positive.

Trait Implementations§

Source§

impl<T: Clone + Real> Clone for Scaling<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Real> Debug for Scaling<T>

Source§

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

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

impl<T: PartialEq + Real> PartialEq for Scaling<T>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<T: PartialEq + Real> StructuralPartialEq for Scaling<T>

Auto Trait Implementations§

§

impl<T> Freeze for Scaling<T>

§

impl<T> RefUnwindSafe for Scaling<T>
where T: RefUnwindSafe,

§

impl<T> Send for Scaling<T>
where T: Send,

§

impl<T> Sync for Scaling<T>
where T: Sync,

§

impl<T> Unpin for Scaling<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Scaling<T>

§

impl<T> UnwindSafe for Scaling<T>
where T: UnwindSafe,

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.