pub struct GivensRotation<T: ComplexField> { /* private fields */ }
Expand description
A Givens rotation.
Implementations§
Source§impl<T: ComplexField> GivensRotation<T>
impl<T: ComplexField> GivensRotation<T>
Sourcepub fn new_unchecked(c: T::RealField, s: T) -> Self
pub fn new_unchecked(c: T::RealField, s: T) -> Self
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.
Sourcepub fn new(c: T, s: T) -> (Self, T)
pub fn new(c: T, s: T) -> (Self, T)
Initializes a Givens rotation from its non-normalized cosine an sine components.
Sourcepub fn try_new(c: T, s: T, eps: T::RealField) -> Option<(Self, T)>
pub fn try_new(c: T, s: T, eps: T::RealField) -> Option<(Self, T)>
Initializes a Givens rotation form its non-normalized cosine an sine components.
Sourcepub fn cancel_y<S: Storage<T, U2>>(v: &Vector<T, U2, S>) -> Option<(Self, T)>
pub fn cancel_y<S: Storage<T, U2>>(v: &Vector<T, U2, S>) -> Option<(Self, T)>
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
.
Sourcepub fn cancel_x<S: Storage<T, U2>>(v: &Vector<T, U2, S>) -> Option<(Self, T)>
pub fn cancel_x<S: Storage<T, U2>>(v: &Vector<T, U2, S>) -> Option<(Self, T)>
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
.
Sourcepub fn rotate<R2: Dim, C2: Dim, S2: StorageMut<T, R2, C2>>(
&self,
rhs: &mut Matrix<T, R2, C2, S2>,
)
pub fn rotate<R2: Dim, C2: Dim, S2: StorageMut<T, R2, C2>>( &self, rhs: &mut Matrix<T, R2, C2, S2>, )
Performs the multiplication rhs = self * rhs
in-place.
Sourcepub fn rotate_rows<R2: Dim, C2: Dim, S2: StorageMut<T, R2, C2>>(
&self,
lhs: &mut Matrix<T, R2, C2, S2>,
)
pub fn rotate_rows<R2: Dim, C2: Dim, S2: StorageMut<T, R2, C2>>( &self, lhs: &mut Matrix<T, R2, C2, S2>, )
Performs the multiplication lhs = lhs * self
in-place.
Trait Implementations§
Source§impl<T: Clone + ComplexField> Clone for GivensRotation<T>
impl<T: Clone + ComplexField> Clone for GivensRotation<T>
Source§fn clone(&self) -> GivensRotation<T>
fn clone(&self) -> GivensRotation<T>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl<T: Debug + ComplexField> Debug for GivensRotation<T>
impl<T: Debug + ComplexField> Debug for GivensRotation<T>
impl<T: Copy + ComplexField> Copy for GivensRotation<T>
Auto Trait Implementations§
impl<T> Freeze for GivensRotation<T>
impl<T> RefUnwindSafe for GivensRotation<T>
impl<T> Send for GivensRotation<T>
impl<T> Sync for GivensRotation<T>
impl<T> Unpin for GivensRotation<T>
impl<T> UnwindSafe for GivensRotation<T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.