Struct rin::math::linalg::givens::GivensRotation

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

A Givens rotation.

Implementations

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

pub fn identity() -> GivensRotation<N>

The Givents rotation that does nothing.

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

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: N, s: N) -> (GivensRotation<N>, N)

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

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

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

pub fn cancel_y<S>(v: &Matrix<N, U2, U1, S>) -> Option<(GivensRotation<N>, N)> where
    S: Storage<N, U2, U1>, 

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<N, U2, U1, S>) -> Option<(GivensRotation<N>, N)> where
    S: Storage<N, U2, U1>, 

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) -> <N as ComplexField>::RealField

The cos part of this roration.

pub fn s(&self) -> N

The sin part of this roration.

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

The inverse of this givens rotation.

pub fn rotate<R2, C2, S2>(&self, rhs: &mut Matrix<N, R2, C2, S2>) where
    C2: Dim,
    R2: Dim,
    S2: StorageMut<N, R2, C2>,
    ShapeConstraint: DimEq<R2, U2>, 

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

pub fn rotate_rows<R2, C2, S2>(&self, lhs: &mut Matrix<N, R2, C2, S2>) where
    C2: Dim,
    R2: Dim,
    S2: StorageMut<N, R2, C2>,
    ShapeConstraint: DimEq<C2, U2>, 

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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