Struct lnkit::prelude::linalg::givens::GivensRotation

pub struct GivensRotation<T> where
    T: ComplexField,  { /* fields omitted */ }

A Givens rotation.

Implementations

impl<T> GivensRotation<T> where
    T: ComplexField, 

pub fn identity() -> GivensRotation<T>

The Givents rotation that does nothing.

pub fn new_unchecked(
    c: <T as ComplexField>::RealField,
    s: T
) -> GivensRotation<T>

Initializes a Givens rotation from its components.

The components are copies as-is. It is not checked whether they describe an actually valid Givens rotation.

pub fn new(c: T, s: T) -> (GivensRotation<T>, T)

Initializes a Givens rotation from its non-normalized cosine an sine components.

pub fn try_new(
    c: T,
    s: T,
    eps: <T as ComplexField>::RealField
) -> Option<(GivensRotation<T>, T)>

Initializes a Givens rotation form its non-normalized cosine an sine components.

pub fn cancel_y<S>(
    v: &Matrix<T, Const<{_: usize}>, Const<1_usize>, S>
) -> Option<(GivensRotation<T>, T)> where
    S: Storage<T, Const<{_: usize}>, Const<1_usize>>, 

Computes the rotation R required such that the y component of R * v is zero.

Returns None if no rotation is needed (i.e. if v.y == 0). Otherwise, this returns the norm of v and the rotation r such that R * v = [ |v|, 0.0 ]^t where |v| is the norm of v.

pub fn cancel_x<S>(
    v: &Matrix<T, Const<{_: usize}>, Const<1_usize>, S>
) -> Option<(GivensRotation<T>, T)> where
    S: Storage<T, Const<{_: usize}>, Const<1_usize>>, 

Computes the rotation R required such that the x component of R * v is zero.

Returns None if no rotation is needed (i.e. if v.x == 0). Otherwise, this returns the norm of v and the rotation r such that R * v = [ 0.0, |v| ]^t where |v| is the norm of v.

pub fn c(&self) -> <T as ComplexField>::RealField

The cos part of this roration.

pub fn s(&self) -> T

The sin part of this roration.

pub fn inverse(&self) -> GivensRotation<T>

The inverse of this givens rotation.

pub fn rotate<R2, C2, S2>(&self, rhs: &mut Matrix<T, R2, C2, S2>) where
    R2: Dim,
    S2: StorageMut<T, R2, C2>,
    C2: Dim,
    ShapeConstraint: DimEq<R2, Const<{_: usize}>>, 

Performs the multiplication rhs = self * rhs in-place.

pub fn rotate_rows<R2, C2, S2>(&self, lhs: &mut Matrix<T, R2, C2, S2>) where
    R2: Dim,
    S2: StorageMut<T, R2, C2>,
    C2: Dim,
    ShapeConstraint: DimEq<C2, Const<{_: usize}>>, 

Performs the multiplication lhs = lhs * self in-place.

Trait Implementations

impl<T> Clone for GivensRotation<T> where
    T: Clone + ComplexField,
    <T as ComplexField>::RealField: Clone, 

pub fn clone(&self) -> GivensRotation<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for GivensRotation<T> where
    T: Copy + ComplexField,
    <T as ComplexField>::RealField: Copy, 

impl<T> Debug for GivensRotation<T> where
    T: Debug + ComplexField,
    <T as ComplexField>::RealField: Debug, 

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

Formats the value using the given formatter.