pub struct GivensRotation<T> where
T: ComplexField, { /* private fields */ }
Expand description
A Givens rotation.
Implementations
sourceimpl<T> GivensRotation<T> where
T: ComplexField,
impl<T> GivensRotation<T> where
T: ComplexField,
sourcepub fn identity() -> GivensRotation<T>
pub fn identity() -> GivensRotation<T>
The Givents rotation that does nothing.
sourcepub fn new_unchecked(
c: <T as ComplexField>::RealField,
s: T
) -> GivensRotation<T>
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.
sourcepub fn new(c: T, s: T) -> (GivensRotation<T>, T)
pub fn new(c: T, s: T) -> (GivensRotation<T>, T)
Initializes a Givens rotation from its non-normalized cosine an sine components.
sourcepub fn try_new(
c: T,
s: T,
eps: <T as ComplexField>::RealField
) -> Option<(GivensRotation<T>, T)>
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.
sourcepub fn cancel_y<S>(
v: &Matrix<T, Const<2_usize>, Const<1_usize>, S>
) -> Option<(GivensRotation<T>, T)> where
S: Storage<T, Const<2_usize>, Const<1_usize>>,
pub fn cancel_y<S>(
v: &Matrix<T, Const<2_usize>, Const<1_usize>, S>
) -> Option<(GivensRotation<T>, T)> where
S: Storage<T, Const<2_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
.
sourcepub fn cancel_x<S>(
v: &Matrix<T, Const<2_usize>, Const<1_usize>, S>
) -> Option<(GivensRotation<T>, T)> where
S: Storage<T, Const<2_usize>, Const<1_usize>>,
pub fn cancel_x<S>(
v: &Matrix<T, Const<2_usize>, Const<1_usize>, S>
) -> Option<(GivensRotation<T>, T)> where
S: Storage<T, Const<2_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
.
sourcepub fn c(&self) -> <T as ComplexField>::RealField
pub fn c(&self) -> <T as ComplexField>::RealField
The cos part of this roration.
sourcepub fn inverse(&self) -> GivensRotation<T>
pub fn inverse(&self) -> GivensRotation<T>
The inverse of this givens rotation.
sourcepub fn rotate<R2, C2, S2>(&self, rhs: &mut Matrix<T, R2, C2, S2>) where
R2: Dim,
C2: Dim,
S2: StorageMut<T, R2, C2>,
ShapeConstraint: DimEq<R2, Const<2_usize>>,
pub fn rotate<R2, C2, S2>(&self, rhs: &mut Matrix<T, R2, C2, S2>) where
R2: Dim,
C2: Dim,
S2: StorageMut<T, R2, C2>,
ShapeConstraint: DimEq<R2, Const<2_usize>>,
Performs the multiplication rhs = self * rhs
in-place.
sourcepub fn rotate_rows<R2, C2, S2>(&self, lhs: &mut Matrix<T, R2, C2, S2>) where
R2: Dim,
C2: Dim,
S2: StorageMut<T, R2, C2>,
ShapeConstraint: DimEq<C2, Const<2_usize>>,
pub fn rotate_rows<R2, C2, S2>(&self, lhs: &mut Matrix<T, R2, C2, S2>) where
R2: Dim,
C2: Dim,
S2: StorageMut<T, R2, C2>,
ShapeConstraint: DimEq<C2, Const<2_usize>>,
Performs the multiplication lhs = lhs * self
in-place.
Trait Implementations
sourceimpl<T> Clone for GivensRotation<T> where
T: Clone + ComplexField,
<T as ComplexField>::RealField: Clone,
impl<T> Clone for GivensRotation<T> where
T: Clone + ComplexField,
<T as ComplexField>::RealField: Clone,
sourcefn clone(&self) -> GivensRotation<T>
fn clone(&self) -> GivensRotation<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<T> Debug for GivensRotation<T> where
T: Debug + ComplexField,
<T as ComplexField>::RealField: Debug,
impl<T> Debug for GivensRotation<T> where
T: Debug + ComplexField,
<T as ComplexField>::RealField: Debug,
impl<T> Copy for GivensRotation<T> where
T: Copy + ComplexField,
<T as ComplexField>::RealField: Copy,
Auto Trait Implementations
impl<T> RefUnwindSafe for GivensRotation<T> where
T: RefUnwindSafe,
<T as ComplexField>::RealField: RefUnwindSafe,
impl<T> Send for GivensRotation<T>
impl<T> Sync for GivensRotation<T>
impl<T> Unpin for GivensRotation<T> where
T: Unpin,
<T as ComplexField>::RealField: Unpin,
impl<T> UnwindSafe for GivensRotation<T> where
T: UnwindSafe,
<T as ComplexField>::RealField: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
sourcefn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
sourcefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
sourcefn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
sourcefn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more