Struct rulinalg::matrix::decomposition::HouseholderComposition

source · [−]

pub struct HouseholderComposition<'a, T>where
    T: 'a,{ /* private fields */ }

Expand description

An efficient representation for a composition of Householder transformations.

This means that HouseholderComposition represents an operator Q of the form

Q = Q_1 * Q_2 * ... * Q_p

as explained in the documentation for HouseholderQr.

Implementations

source

impl<'a, T> HouseholderComposition<'a, T>where
T: Float,

source

pub fn left_multiply_into<X>(&self, matrix: &mut X)where
X: BaseMatrixMut<T>,

Given a matrix A of compatible dimensions, computes the product A <- QA, storing the result in A.

source

pub fn first_k_columns(&self, k: usize) -> Matrix<T>

Computes the first k columns of the implicitly stored matrix Q.

Panics

k must be less than or equal to m, the number of rows of Q.

Trait Implementations

source

impl<'a, T: Clone> Clone for HouseholderComposition<'a, T>where
T: 'a,

source

fn clone(&self) -> HouseholderComposition<'a, T>

Returns a copy of the value. Read more

1.0.0

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

Performs copy-assignment from source. Read more

source

impl<'a, T: Debug> Debug for HouseholderComposition<'a, T>where
T: 'a,

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<'a, T> RefUnwindSafe for HouseholderComposition<'a, T>where
T: RefUnwindSafe,

impl<'a, T> Send for HouseholderComposition<'a, T>where
T: Sync,

impl<'a, T> Sync for HouseholderComposition<'a, T>where
T: Sync,

impl<'a, T> Unpin for HouseholderComposition<'a, T>

impl<'a, T> UnwindSafe for HouseholderComposition<'a, T>where
T: RefUnwindSafe,

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere
U: From<T>,

const: unstable

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct rulinalg::matrix::decomposition::HouseholderComposition

Implementations

impl<'a, T> HouseholderComposition<'a, T>where
T: Float,

pub fn left_multiply_into<X>(&self, matrix: &mut X)where
X: BaseMatrixMut<T>,

pub fn first_k_columns(&self, k: usize) -> Matrix<T>

Panics

Trait Implementations

impl<'a, T: Clone> Clone for HouseholderComposition<'a, T>where
T: 'a,

fn clone(&self) -> HouseholderComposition<'a, T>

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

impl<'a, T: Debug> Debug for HouseholderComposition<'a, T>where
T: 'a,

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

Auto Trait Implementations

impl<'a, T> RefUnwindSafe for HouseholderComposition<'a, T>where
T: RefUnwindSafe,

impl<'a, T> Send for HouseholderComposition<'a, T>where
T: Sync,

impl<'a, T> Sync for HouseholderComposition<'a, T>where
T: Sync,

impl<'a, T> Unpin for HouseholderComposition<'a, T>

impl<'a, T> UnwindSafe for HouseholderComposition<'a, T>where
T: RefUnwindSafe,

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere
U: From<T>,

fn into(self) -> U

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct rulinalg::matrix::decomposition::HouseholderComposition

Implementations

impl<'a, T> HouseholderComposition<'a, T>where T: Float,

pub fn left_multiply_into<X>(&self, matrix: &mut X)where X: BaseMatrixMut<T>,

pub fn first_k_columns(&self, k: usize) -> Matrix<T>

Panics

Trait Implementations

impl<'a, T: Clone> Clone for HouseholderComposition<'a, T>where T: 'a,

fn clone(&self) -> HouseholderComposition<'a, T>

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

impl<'a, T: Debug> Debug for HouseholderComposition<'a, T>where T: 'a,

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

Auto Trait Implementations

impl<'a, T> RefUnwindSafe for HouseholderComposition<'a, T>where T: RefUnwindSafe,

impl<'a, T> Send for HouseholderComposition<'a, T>where T: Sync,

impl<'a, T> Sync for HouseholderComposition<'a, T>where T: Sync,

impl<'a, T> Unpin for HouseholderComposition<'a, T>

impl<'a, T> UnwindSafe for HouseholderComposition<'a, T>where T: RefUnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<'a, T> HouseholderComposition<'a, T>where
T: Float,

pub fn left_multiply_into<X>(&self, matrix: &mut X)where
X: BaseMatrixMut<T>,

impl<'a, T: Clone> Clone for HouseholderComposition<'a, T>where
T: 'a,

impl<'a, T: Debug> Debug for HouseholderComposition<'a, T>where
T: 'a,

impl<'a, T> RefUnwindSafe for HouseholderComposition<'a, T>where
T: RefUnwindSafe,

impl<'a, T> Send for HouseholderComposition<'a, T>where
T: Sync,

impl<'a, T> Sync for HouseholderComposition<'a, T>where
T: Sync,

impl<'a, T> UnwindSafe for HouseholderComposition<'a, T>where
T: RefUnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

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

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,