Struct nalgebra::linalg::givens::GivensRotation

source · [−]

pub struct GivensRotation<T: ComplexField> { /* private fields */ }

Expand description

A Givens rotation.

Implementations

source

impl<T: ComplexField> GivensRotation<T>

source

pub fn identity() -> Self

The Givents rotation that does nothing.

source

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.

source

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

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

source

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.

source

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.

source

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.

source

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

The cos part of this roration.

source

pub fn s(&self) -> T

The sin part of this roration.

source

pub fn inverse(&self) -> Self

The inverse of this givens rotation.

source

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

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

source

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

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

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

impl<T: Copy + ComplexField> Copy for GivensRotation<T>where
T::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

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

source

fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
 W: DeserializeWith<F, T, D>,
 D: Fallible + ?Sized,
 F: ?Sized,

source

fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointee for T

type Metadata = ()

The type for metadata in pointers and references to Self.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

source

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

source

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

source

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

source

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

source

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

source

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

source

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

source

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct nalgebra::linalg::givens::GivensRotation

Implementations

impl<T: ComplexField> GivensRotation<T>

pub fn identity() -> Self

pub fn new_unchecked(c: T::RealField, s: T) -> Self

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

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

pub fn cancel_y<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)>

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

pub fn s(&self) -> T

pub fn inverse(&self) -> Self

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

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

Trait Implementations

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

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

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

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

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

impl<T: Copy + ComplexField> Copy for GivensRotation<T>where T::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

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

fn pointer_metadata( &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

fn deserialize( &self, deserializer: &mut D) -> Result<With<T, W>, <D as Fallible>::Error>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointee for T

type Metadata = ()

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

unsafe fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

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

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

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

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

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

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

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,

impl<T> Any for Twhere
T: 'static + ?Sized,

fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,

fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,