[][src]Struct nalgebra::linalg::givens::GivensRotation

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

A Givens rotation.

Methods

impl<N: ComplexField> GivensRotation<N>[src]

pub fn identity() -> Self[src]

The Givents rotation that does nothing.

pub fn new_unchecked(c: N::RealField, s: N) -> Self[src]

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) -> (Self, N)[src]

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

pub fn try_new(c: N, s: N, eps: N::RealField) -> Option<(Self, N)>[src]

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

pub fn cancel_y<S: Storage<N, U2>>(v: &Vector<N, U2, S>) -> Option<(Self, N)>[src]

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: Storage<N, U2>>(v: &Vector<N, U2, S>) -> Option<(Self, N)>[src]

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::RealField[src]

The cos part of this roration.

pub fn s(&self) -> N[src]

The sin part of this roration.

pub fn inverse(&self) -> Self[src]

The inverse of this givens rotation.

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

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

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

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

Trait Implementations

impl<N: Copy + ComplexField> Copy for GivensRotation<N> where
    N::RealField: Copy
[src]

impl<N: Clone + ComplexField> Clone for GivensRotation<N> where
    N::RealField: Clone
[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<N: Debug + ComplexField> Debug for GivensRotation<N> where
    N::RealField: Debug
[src]

Auto Trait Implementations

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

impl<N> Sync for GivensRotation<N> where
    <N as ComplexField>::RealField: Sync

impl<N> Send for GivensRotation<N> where
    <N as ComplexField>::RealField: Send

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

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

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]