Struct ndarray_linalg::krylov::householder::Householder

source ·
pub struct Householder<A: Scalar> { /* private fields */ }
Expand description

Iterative orthogonalizer using Householder reflection

Implementations§

source§

impl<A: Scalar + Lapack> Householder<A>

source

pub fn new(dim: usize, tol: A::Real) -> Self

Create a new orthogonalizer

source

pub fn forward_reflection<S>(&self, a: &mut ArrayBase<S, Ix1>)
where S: DataMut<Elem = A>,

Take forward reflection P = P_l ... P_1

source

pub fn backward_reflection<S>(&self, a: &mut ArrayBase<S, Ix1>)
where S: DataMut<Elem = A>,

Take backward reflection P = P_1 ... P_l

Trait Implementations§

source§

impl<A: Clone + Scalar> Clone for Householder<A>
where A::Real: Clone,

source§

fn clone(&self) -> Householder<A>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<A: Debug + Scalar> Debug for Householder<A>
where A::Real: Debug,

source§

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

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

impl<A: Scalar + Lapack> Orthogonalizer for Householder<A>

source§

type Elem = A

source§

fn dim(&self) -> usize

Dimension of input array
source§

fn len(&self) -> usize

Number of cached basis
source§

fn tolerance(&self) -> A::Real

source§

fn decompose<S>(&self, a: &mut ArrayBase<S, Ix1>) -> Array1<A>
where S: DataMut<Elem = A>,

Decompose given vector into the span of current basis and its tangent space Read more
source§

fn coeff<S>(&self, a: ArrayBase<S, Ix1>) -> Array1<A>
where S: Data<Elem = A>,

Calculate the coefficient to the current basis basis Read more
source§

fn div_append<S>(&mut self, a: &mut ArrayBase<S, Ix1>) -> AppendResult<A>
where S: DataMut<Elem = A>,

Add new vector if the residual is larger than relative tolerance, and return the residual vector
source§

fn append<S>(&mut self, a: ArrayBase<S, Ix1>) -> AppendResult<A>
where S: Data<Elem = A>,

Add new vector if the residual is larger than relative tolerance
source§

fn get_q(&self) -> Q<A>

Get Q-matrix of generated basis
source§

fn is_full(&self) -> bool

check if the basis spans entire space
source§

fn is_empty(&self) -> bool

Auto Trait Implementations§

§

impl<A> Freeze for Householder<A>
where <A as Scalar>::Real: Freeze,

§

impl<A> RefUnwindSafe for Householder<A>

§

impl<A> Send for Householder<A>
where <A as Scalar>::Real: Send, A: Send,

§

impl<A> Sync for Householder<A>
where <A as Scalar>::Real: Sync, A: Sync,

§

impl<A> Unpin for Householder<A>
where <A as Scalar>::Real: Unpin,

§

impl<A> UnwindSafe for Householder<A>
where <A as Scalar>::Real: UnwindSafe, A: RefUnwindSafe,

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
source§

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

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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 = Infallible

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

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

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V