Struct Rotation2 

pub struct Rotation2<S>(/* private fields */)
where
    S: Ring + MaybeSerDes;

Orthogonal 2x2 matrix with determinant +1, i.e. a member of the circle group $SO(2)$ of special orthogonal matrices

Implementations

impl<S> Rotation2<S>

where S: Ring + MaybeSerDes,

pub fn identity() -> Self

Identity rotation

pub fn new(mat: Matrix2<S>) -> Option<Self>

Returns None if called with a matrix that is not orthonormal with determinant +1.

This method checks whether mat * mat^T == I and mat.determinant() == 1.

pub fn new_approx(mat: Matrix2<S>) -> Option<Self>

where S: RelativeEq<Epsilon = S>,

Returns None if called with a matrix that is not orthonormal with determinant +1.

This method checks whether mat * mat^T == I and mat.determinant() == 1 (approximately using relative equality).

pub fn from_angle(angle: Rad<S>) -> Self

where S: Real,

Create a rotation for the given angle

pub fn noisy(mat: Matrix2<S>) -> Self

where S: Debug,

Panic if the given matrix is not orthogonal with determinant +1.

This method checks whether mat * mat^T == I and mat.determinant() == 1.

pub fn noisy_approx(mat: Matrix2<S>) -> Self

where S: RelativeEq<Epsilon = S> + Debug,

Panic if the given matrix is not orthogonal with determinant +1.

This method checks whether mat * mat^T == I and mat.determinant() == 1 (approximately using relative equality).

pub fn unchecked(mat: Matrix2<S>) -> Self

where S: Debug,

It is a debug panic if the given matrix is not orthogonal with determinant +1.

This method checks whether mat * mat^T == I and mat.determinant() == 1.

pub fn unchecked_approx(mat: Matrix2<S>) -> Self

where S: RelativeEq<Epsilon = S> + Debug,

It is a debug panic if the given matrix is not orthogonal with determinant +1.

This method checks whether mat * mat^T == I and mat.determinant() == 1 (approximately using relative equality).

pub const fn mat(self) -> Matrix2<S>

Get the underlying matrix

pub fn rotate(self, point: Point2<S>) -> Point2<S>

Rotates a point around the origin

pub fn rotate_around(self, point: Point2<S>, center: Point2<S>) -> Point2<S>

Rotate around a center point

Methods from Deref<Target = LinearAuto<S, Vector2<S>>>

pub fn is_orthonormal(&self) -> bool

Returns false if called with a matrix that is not orthogonal with determinant +/-1.

This method checks whether mat * mat^T == I and mat.determinant() == +/-1.

pub fn is_orthonormal_approx(&self) -> bool

where S: RelativeEq<Epsilon = S>, V::LinearEndo: RelativeEq<Epsilon = S>,

Returns None if called with a matrix that is not orthogonal with determinant +/-1.

This method checks whether mat * mat^T == I and mat.determinant() == +/-1 (approximately using relative equality).

pub fn is_rotation(&self) -> bool

Checks whether the transformation is a special orthogonal matrix.

This method checks whether mat * mat^T == I and mat.determinant() == 1.

pub fn is_rotation_approx(&self) -> bool

where S: RelativeEq<Epsilon = S>, V::LinearEndo: RelativeEq<Epsilon = S>,

Checks whether the transformation is a special orthogonal matrix.

This method checks whether mat * mat^T == I and mat.determinant() == 1 (approximately using relative equality).

Trait Implementations

impl<S> Clone for Rotation2<S>

where S: Ring + MaybeSerDes + Clone,

fn clone(&self) -> Rotation2<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Rotation2<S>

where S: Ring + MaybeSerDes + Debug,

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

Formats the value using the given formatter.

impl<S> Default for Rotation2<S>

where S: Ring + MaybeSerDes + Default,

fn default() -> Rotation2<S>

Returns the “default value” for a type.

impl<S> Deref for Rotation2<S>

where S: Ring + MaybeSerDes,

type Target = LinearAuto<S, Vec2<S>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S> Div for Rotation2<S>

where S: Ring + MaybeSerDes,

type Output = Rotation2<S>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<S> DivAssign for Rotation2<S>

where S: Ring + MaybeSerDes,

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<S> Inv for Rotation2<S>

where S: Ring + MaybeSerDes,

type Output = Rotation2<S>

The result after applying the operator.

fn inv(self) -> Self::Output

Returns the multiplicative inverse of self.

impl<S> Mul<Rotation2<S>> for Vector2<S>

where S: Ring + MaybeSerDes,

type Output = Vec2<S>

The resulting type after applying the * operator.

fn mul(self, rhs: Rotation2<S>) -> Self::Output

Performs the * operation.

impl<S> Mul<Vec2<S>> for Rotation2<S>

where S: Ring + MaybeSerDes,

type Output = Vec2<S>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector2<S>) -> Self::Output

Performs the * operation.

impl<S> Mul for Rotation2<S>

where S: Ring + MaybeSerDes,

type Output = Rotation2<S>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<S> MulAssign for Rotation2<S>

where S: Ring + MaybeSerDes,

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<S> One for Rotation2<S>

where S: Ring + MaybeSerDes + Zero + One,

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl<S> PartialEq for Rotation2<S>

where S: Ring + MaybeSerDes + PartialEq,

fn eq(&self, other: &Rotation2<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S> Copy for Rotation2<S>

where S: Ring + MaybeSerDes + Copy,

impl<S> StructuralPartialEq for Rotation2<S>

where S: Ring + MaybeSerDes,