Type Alias nalgebra::geometry::Similarity2

pub type Similarity2<T> = Similarity<T, UnitComplex<T>, 2>;

A 2-dimensional similarity.

Aliased Type

struct Similarity2<T> {
    pub isometry: Isometry<T, Unit<Complex<T>>, 2>,
    /* private fields */
}

Fields

isometry: Isometry<T, Unit<Complex<T>>, 2>

The part of this similarity that does not include the scaling factor.

Implementations

impl<T: SimdRealField, R, const D: usize> Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

pub fn from_scaling(scaling: T) -> Self

Creates a new similarity that applies only a scaling factor.

pub fn inverse(&self) -> Self

Inverts self.

pub fn inverse_mut(&mut self)

Inverts self in-place.

pub fn prepend_scaling(&self, scaling: T) -> Self

The similarity transformation that applies a scaling factor scaling before self.

pub fn append_scaling(&self, scaling: T) -> Self

The similarity transformation that applies a scaling factor scaling after self.

pub fn prepend_scaling_mut(&mut self, scaling: T)

Sets self to the similarity transformation that applies a scaling factor scaling before self.

pub fn append_scaling_mut(&mut self, scaling: T)

Sets self to the similarity transformation that applies a scaling factor scaling after self.

pub fn append_translation_mut(&mut self, t: &Translation<T, D>)

Appends to self the given translation in-place.

pub fn append_rotation_mut(&mut self, r: &R)

Appends to self the given rotation in-place.

pub fn append_rotation_wrt_point_mut(&mut self, r: &R, p: &Point<T, D>)

Appends in-place to self a rotation centered at the point p, i.e., the rotation that lets p invariant.

pub fn append_rotation_wrt_center_mut(&mut self, r: &R)

Appends in-place to self a rotation centered at the point with coordinates self.translation.

pub fn transform_point(&self, pt: &Point<T, D>) -> Point<T, D>

Transform the given point by this similarity.

This is the same as the multiplication self * pt.

Example

let axisangle = Vector3::y() * f32::consts::FRAC_PI_2;
let translation = Vector3::new(1.0, 2.0, 3.0);
let sim = Similarity3::new(translation, axisangle, 3.0);
let transformed_point = sim.transform_point(&Point3::new(4.0, 5.0, 6.0));
assert_relative_eq!(transformed_point, Point3::new(19.0, 17.0, -9.0), epsilon = 1.0e-5);

pub fn transform_vector(&self, v: &SVector<T, D>) -> SVector<T, D>

Transform the given vector by this similarity, ignoring the translational component.

This is the same as the multiplication self * t.

Example

let axisangle = Vector3::y() * f32::consts::FRAC_PI_2;
let translation = Vector3::new(1.0, 2.0, 3.0);
let sim = Similarity3::new(translation, axisangle, 3.0);
let transformed_vector = sim.transform_vector(&Vector3::new(4.0, 5.0, 6.0));
assert_relative_eq!(transformed_vector, Vector3::new(18.0, 15.0, -12.0), epsilon = 1.0e-5);

pub fn inverse_transform_point(&self, pt: &Point<T, D>) -> Point<T, D>

Transform the given point by the inverse of this similarity. This may be cheaper than inverting the similarity and then transforming the given point.

Example

let axisangle = Vector3::y() * f32::consts::FRAC_PI_2;
let translation = Vector3::new(1.0, 2.0, 3.0);
let sim = Similarity3::new(translation, axisangle, 2.0);
let transformed_point = sim.inverse_transform_point(&Point3::new(4.0, 5.0, 6.0));
assert_relative_eq!(transformed_point, Point3::new(-1.5, 1.5, 1.5), epsilon = 1.0e-5);

pub fn inverse_transform_vector(&self, v: &SVector<T, D>) -> SVector<T, D>

Transform the given vector by the inverse of this similarity, ignoring the translational component. This may be cheaper than inverting the similarity and then transforming the given vector.

Example

let axisangle = Vector3::y() * f32::consts::FRAC_PI_2;
let translation = Vector3::new(1.0, 2.0, 3.0);
let sim = Similarity3::new(translation, axisangle, 2.0);
let transformed_vector = sim.inverse_transform_vector(&Vector3::new(4.0, 5.0, 6.0));
assert_relative_eq!(transformed_vector, Vector3::new(-3.0, 2.5, 2.0), epsilon = 1.0e-5);

impl<T: SimdRealField, R, const D: usize> Similarity<T, R, D>

pub fn to_homogeneous( &self ) -> OMatrix<T, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>

where Const<D>: DimNameAdd<U1>, R: SubsetOf<OMatrix<T, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>>, DefaultAllocator: Allocator<T, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>,

Converts this similarity into its equivalent homogeneous transformation matrix.

impl<T: Scalar + Zero, R, const D: usize> Similarity<T, R, D>

where R: AbstractRotation<T, D>,

pub fn from_parts( translation: Translation<T, D>, rotation: R, scaling: T ) -> Self

Creates a new similarity from its rotational and translational parts.

pub fn from_isometry(isometry: Isometry<T, R, D>, scaling: T) -> Self

Creates a new similarity from its rotational and translational parts.

pub fn set_scaling(&mut self, scaling: T)

The scaling factor of this similarity transformation.

impl<T: Scalar, R, const D: usize> Similarity<T, R, D>

pub fn scaling(&self) -> T

The scaling factor of this similarity transformation.

impl<T: SimdRealField, R, const D: usize> Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

pub fn identity() -> Self

Creates a new identity similarity.

Example

let sim = Similarity2::identity();
let pt = Point2::new(1.0, 2.0);
assert_eq!(sim * pt, pt);

let sim = Similarity3::identity();
let pt = Point3::new(1.0, 2.0, 3.0);
assert_eq!(sim * pt, pt);

impl<T: SimdRealField, R, const D: usize> Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

pub fn rotation_wrt_point(r: R, p: Point<T, D>, scaling: T) -> Self

The similarity that applies the scaling factor scaling, followed by the rotation r with its axis passing through the point p.

Example

let rot = UnitComplex::new(f32::consts::FRAC_PI_2);
let pt = Point2::new(3.0, 2.0);
let sim = Similarity2::rotation_wrt_point(rot, pt, 4.0);

assert_relative_eq!(sim * Point2::new(1.0, 2.0), Point2::new(-3.0, 3.0), epsilon = 1.0e-6);

impl<T: SimdRealField> Similarity<T, UnitComplex<T>, 2>

where T::Element: SimdRealField,

pub fn new(translation: Vector2<T>, angle: T, scaling: T) -> Self

Creates a new similarity from a translation and a rotation angle.

Example

let sim = Similarity2::new(Vector2::new(1.0, 2.0), f32::consts::FRAC_PI_2, 3.0);

assert_relative_eq!(sim * Point2::new(2.0, 4.0), Point2::new(-11.0, 8.0), epsilon = 1.0e-6);

pub fn cast<To: Scalar>(self) -> Similarity<To, UnitComplex<To>, 2>

where Similarity<To, UnitComplex<To>, 2>: SupersetOf<Self>,

Cast the components of self to another type.

Example

let sim = Similarity2::<f64>::identity();
let sim2 = sim.cast::<f32>();
assert_eq!(sim2, Similarity2::<f32>::identity());

Trait Implementations

impl<T: RealField, R, const D: usize> AbsDiffEq for Similarity<T, R, D>

where R: AbstractRotation<T, D> + AbsDiffEq<Epsilon = T::Epsilon>, T::Epsilon: Clone,

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Clone, R: Clone, const D: usize> Clone for Similarity<T, R, D>

fn clone(&self) -> Similarity<T, R, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, R: Debug, const D: usize> Debug for Similarity<T, R, D>

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

Formats the value using the given formatter.

impl<T: SimdRealField, R, const D: usize> Default for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T, R, const D: usize> Deserialize<'de> for Similarity<T, R, D>

where T: Scalar + Deserialize<'de>, R: Deserialize<'de>, DefaultAllocator: Allocator<T, Const<D>>, Owned<T, Const<D>>: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, R, const D: usize> Display for Similarity<T, R, D>

where T: RealField + Display, R: AbstractRotation<T, D> + Display,

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

Formats the value using the given formatter.

impl<'b, T: SimdRealField, R, const D: usize> Div<&'b Isometry<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the / operator.

fn div(self, rhs: &'b Isometry<T, R, D>) -> Self::Output

Performs the / operation.

impl<'b, T: SimdRealField, R, const D: usize> Div<&'b Similarity<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the / operator.

fn div(self, rhs: &'b Similarity<T, R, D>) -> Self::Output

Performs the / operation.

impl<'b, T: SimdRealField> Div<&'b Unit<Complex<T>>> for Similarity<T, UnitComplex<T>, 2>

where T::Element: SimdRealField,

type Output = Similarity<T, Unit<Complex<T>>, 2>

The resulting type after applying the / operator.

fn div(self, rhs: &'b UnitComplex<T>) -> Self::Output

Performs the / operation.

impl<T: SimdRealField, R, const D: usize> Div<Isometry<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the / operator.

fn div(self, rhs: Isometry<T, R, D>) -> Self::Output

Performs the / operation.

impl<T: SimdRealField> Div<Unit<Complex<T>>> for Similarity<T, UnitComplex<T>, 2>

where T::Element: SimdRealField,

type Output = Similarity<T, Unit<Complex<T>>, 2>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: SimdRealField, R, const D: usize> Div for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the / operator.

fn div(self, rhs: Similarity<T, R, D>) -> Self::Output

Performs the / operation.

impl<'b, T: SimdRealField, R, const D: usize> DivAssign<&'b Isometry<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn div_assign(&mut self, rhs: &'b Isometry<T, R, D>)

Performs the /= operation.

impl<'b, T: SimdRealField, R, const D: usize> DivAssign<&'b Similarity<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn div_assign(&mut self, rhs: &'b Similarity<T, R, D>)

Performs the /= operation.

impl<'b, T> DivAssign<&'b Unit<Complex<T>>> for Similarity<T, UnitComplex<T>, 2>

where T: Scalar + Zero + One + ClosedAdd + ClosedMul + SimdRealField, T::Element: SimdRealField,

fn div_assign(&mut self, rhs: &'b UnitComplex<T>)

Performs the /= operation.

impl<T: SimdRealField, R, const D: usize> DivAssign<Isometry<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn div_assign(&mut self, rhs: Isometry<T, R, D>)

Performs the /= operation.

impl<T> DivAssign<Unit<Complex<T>>> for Similarity<T, UnitComplex<T>, 2>

where T: Scalar + Zero + One + ClosedAdd + ClosedMul + SimdRealField, T::Element: SimdRealField,

fn div_assign(&mut self, rhs: UnitComplex<T>)

Performs the /= operation.

impl<T: SimdRealField, R, const D: usize> DivAssign for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn div_assign(&mut self, rhs: Similarity<T, R, D>)

Performs the /= operation.

impl<T, R, const D: usize> From<[Similarity<<T as SimdValue>::Element, <R as SimdValue>::Element, D>; 16]> for Similarity<T, R, D>

where T: From<[<T as SimdValue>::Element; 16]> + Scalar + Zero + PrimitiveSimdValue, R: SimdValue + AbstractRotation<T, D> + From<[<R as SimdValue>::Element; 16]>, R::Element: AbstractRotation<T::Element, D> + Scalar + Zero + Copy, T::Element: Scalar + Zero + Copy,

fn from(arr: [Similarity<T::Element, R::Element, D>; 16]) -> Self

Converts to this type from the input type.

impl<T, R, const D: usize> From<[Similarity<<T as SimdValue>::Element, <R as SimdValue>::Element, D>; 2]> for Similarity<T, R, D>

where T: From<[<T as SimdValue>::Element; 2]> + Scalar + Zero + PrimitiveSimdValue, R: SimdValue + AbstractRotation<T, D> + From<[<R as SimdValue>::Element; 2]>, R::Element: AbstractRotation<T::Element, D> + Scalar + Zero + Copy, T::Element: Scalar + Zero + Copy,

fn from(arr: [Similarity<T::Element, R::Element, D>; 2]) -> Self

Converts to this type from the input type.

impl<T, R, const D: usize> From<[Similarity<<T as SimdValue>::Element, <R as SimdValue>::Element, D>; 4]> for Similarity<T, R, D>

where T: From<[<T as SimdValue>::Element; 4]> + Scalar + Zero + PrimitiveSimdValue, R: SimdValue + AbstractRotation<T, D> + From<[<R as SimdValue>::Element; 4]>, R::Element: AbstractRotation<T::Element, D> + Scalar + Zero + Copy, T::Element: Scalar + Zero + Copy,

fn from(arr: [Similarity<T::Element, R::Element, D>; 4]) -> Self

Converts to this type from the input type.

impl<T, R, const D: usize> From<[Similarity<<T as SimdValue>::Element, <R as SimdValue>::Element, D>; 8]> for Similarity<T, R, D>

where T: From<[<T as SimdValue>::Element; 8]> + Scalar + Zero + PrimitiveSimdValue, R: SimdValue + AbstractRotation<T, D> + From<[<R as SimdValue>::Element; 8]>, R::Element: AbstractRotation<T::Element, D> + Scalar + Zero + Copy, T::Element: Scalar + Zero + Copy,

fn from(arr: [Similarity<T::Element, R::Element, D>; 8]) -> Self

Converts to this type from the input type.

impl<T: Scalar + Hash, R: Hash, const D: usize> Hash for Similarity<T, R, D>

where Owned<T, Const<D>>: Hash,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'b, T: SimdRealField, R, const D: usize> Mul<&'b Isometry<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Isometry<T, R, D>) -> Self::Output

Performs the * operation.

impl<'b, T: SimdRealField, R, const D: usize> Mul<&'b Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>

The resulting type after applying the * operator.

fn mul(self, right: &'b SVector<T, D>) -> Self::Output

Performs the * operation.

impl<'b, T: SimdRealField, R, const D: usize> Mul<&'b OPoint<T, Const<D>>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = OPoint<T, Const<D>>

The resulting type after applying the * operator.

fn mul(self, right: &'b Point<T, D>) -> Self::Output

Performs the * operation.

impl<'b, T: SimdRealField, R, const D: usize> Mul<&'b Similarity<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Similarity<T, R, D>) -> Self::Output

Performs the * operation.

impl<'b, T, C, R, const D: usize> Mul<&'b Transform<T, C, D>> for Similarity<T, R, D>

where T: Scalar + Zero + One + ClosedAdd + ClosedMul + RealField, Const<D>: DimNameAdd<U1>, C: TCategoryMul<TAffine>, R: SubsetOf<OMatrix<T, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>>, DefaultAllocator: Allocator<T, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>,

type Output = Transform<T, <C as TCategoryMul<TAffine>>::Representative, D>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Transform<T, C, D>) -> Self::Output

Performs the * operation.

impl<'b, T: SimdRealField, R, const D: usize> Mul<&'b Translation<T, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the * operator.

fn mul(self, right: &'b Translation<T, D>) -> Self::Output

Performs the * operation.

impl<'b, T: SimdRealField> Mul<&'b Unit<Complex<T>>> for Similarity<T, UnitComplex<T>, 2>

where T::Element: SimdRealField,

type Output = Similarity<T, Unit<Complex<T>>, 2>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b UnitComplex<T>) -> Self::Output

Performs the * operation.

impl<T: SimdRealField, R, const D: usize> Mul<Isometry<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the * operator.

fn mul(self, rhs: Isometry<T, R, D>) -> Self::Output

Performs the * operation.

impl<T: SimdRealField, R, const D: usize> Mul<Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>

The resulting type after applying the * operator.

fn mul(self, right: SVector<T, D>) -> Self::Output

Performs the * operation.

impl<T: SimdRealField, R, const D: usize> Mul<OPoint<T, Const<D>>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = OPoint<T, Const<D>>

The resulting type after applying the * operator.

fn mul(self, right: Point<T, D>) -> Self::Output

Performs the * operation.

impl<T, C, R, const D: usize> Mul<Transform<T, C, D>> for Similarity<T, R, D>

where T: Scalar + Zero + One + ClosedAdd + ClosedMul + RealField, Const<D>: DimNameAdd<U1>, C: TCategoryMul<TAffine>, R: SubsetOf<OMatrix<T, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>>, DefaultAllocator: Allocator<T, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>,

type Output = Transform<T, <C as TCategoryMul<TAffine>>::Representative, D>

The resulting type after applying the * operator.

fn mul(self, rhs: Transform<T, C, D>) -> Self::Output

Performs the * operation.

impl<T: SimdRealField, R, const D: usize> Mul<Translation<T, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the * operator.

fn mul(self, right: Translation<T, D>) -> Self::Output

Performs the * operation.

impl<T: SimdRealField> Mul<Unit<Complex<T>>> for Similarity<T, UnitComplex<T>, 2>

where T::Element: SimdRealField,

type Output = Similarity<T, Unit<Complex<T>>, 2>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: SimdRealField, R, const D: usize> Mul for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

type Output = Similarity<T, R, D>

The resulting type after applying the * operator.

fn mul(self, rhs: Similarity<T, R, D>) -> Self::Output

Performs the * operation.

impl<'b, T: SimdRealField, R, const D: usize> MulAssign<&'b Isometry<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn mul_assign(&mut self, rhs: &'b Isometry<T, R, D>)

Performs the *= operation.

impl<'b, T: SimdRealField, R, const D: usize> MulAssign<&'b Similarity<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn mul_assign(&mut self, rhs: &'b Similarity<T, R, D>)

Performs the *= operation.

impl<'b, T: SimdRealField, R, const D: usize> MulAssign<&'b Translation<T, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn mul_assign(&mut self, rhs: &'b Translation<T, D>)

Performs the *= operation.

impl<'b, T> MulAssign<&'b Unit<Complex<T>>> for Similarity<T, UnitComplex<T>, 2>

where T: Scalar + Zero + One + ClosedAdd + ClosedMul + SimdRealField, T::Element: SimdRealField,

fn mul_assign(&mut self, rhs: &'b UnitComplex<T>)

Performs the *= operation.

impl<T: SimdRealField, R, const D: usize> MulAssign<Isometry<T, R, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn mul_assign(&mut self, rhs: Isometry<T, R, D>)

Performs the *= operation.

impl<T: SimdRealField, R, const D: usize> MulAssign<Translation<T, D>> for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn mul_assign(&mut self, rhs: Translation<T, D>)

Performs the *= operation.

impl<T> MulAssign<Unit<Complex<T>>> for Similarity<T, UnitComplex<T>, 2>

where T: Scalar + Zero + One + ClosedAdd + ClosedMul + SimdRealField, T::Element: SimdRealField,

fn mul_assign(&mut self, rhs: UnitComplex<T>)

Performs the *= operation.

impl<T: SimdRealField, R, const D: usize> MulAssign for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn mul_assign(&mut self, rhs: Similarity<T, R, D>)

Performs the *= operation.

impl<T: SimdRealField, R, const D: usize> One for Similarity<T, R, D>

where T::Element: SimdRealField, R: AbstractRotation<T, D>,

fn one() -> Self

Creates a new identity similarity.

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<T: SimdRealField, R, const D: usize> PartialEq for Similarity<T, R, D>

where R: AbstractRotation<T, D> + PartialEq,

fn eq(&self, right: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: RealField, R, const D: usize> RelativeEq for Similarity<T, R, D>

where R: AbstractRotation<T, D> + RelativeEq<Epsilon = T::Epsilon>, T::Epsilon: Clone,

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T, R, const D: usize> Serialize for Similarity<T, R, D>

where T: Scalar + Serialize, R: Serialize, DefaultAllocator: Allocator<T, Const<D>>, Owned<T, Const<D>>: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: SimdRealField, R, const D: usize> SimdValue for Similarity<T, R, D>

where T::Element: SimdRealField, R: SimdValue<SimdBool = T::SimdBool> + AbstractRotation<T, D>, R::Element: AbstractRotation<T::Element, D>,

type Element = Similarity<<T as SimdValue>::Element, <R as SimdValue>::Element, D>

The type of the elements of each lane of this SIMD value.

type SimdBool = <T as SimdValue>::SimdBool

Type of the result of comparing two SIMD values like self.

fn lanes() -> usize

The number of lanes of this SIMD value.

fn splat(val: Self::Element) -> Self

Initializes an SIMD value with each lanes set to val.

fn extract(&self, i: usize) -> Self::Element

Extracts the i-th lane of self.

unsafe fn extract_unchecked(&self, i: usize) -> Self::Element

Extracts the i-th lane of self without bound-checking.

fn replace(&mut self, i: usize, val: Self::Element)

Replaces the i-th lane of self by val.

unsafe fn replace_unchecked(&mut self, i: usize, val: Self::Element)

Replaces the i-th lane of self by val without bound-checking.

fn select(self, cond: Self::SimdBool, other: Self) -> Self

Merges self and other depending on the lanes of cond.

fn map_lanes(self, f: impl Fn(Self::Element) -> Self::Element) -> Self

where Self: Clone,

Applies a function to each lane of self.

fn zip_map_lanes( self, b: Self, f: impl Fn(Self::Element, Self::Element) -> Self::Element ) -> Self

where Self: Clone,

Applies a function to each lane of self paired with the corresponding lane of b.

impl<T1, T2, R, const D: usize> SubsetOf<Matrix<T2, <Const<D> as DimNameAdd<Const<1>>>::Output, <Const<D> as DimNameAdd<Const<1>>>::Output, <DefaultAllocator as Allocator<T2, <Const<D> as DimNameAdd<Const<1>>>::Output, <Const<D> as DimNameAdd<Const<1>>>::Output>>::Buffer>> for Similarity<T1, R, D>

where T1: RealField, T2: RealField + SupersetOf<T1>, R: AbstractRotation<T1, D> + SubsetOf<OMatrix<T1, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>> + SubsetOf<OMatrix<T2, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>>, Const<D>: DimNameAdd<U1> + DimMin<Const<D>, Output = Const<D>>, DefaultAllocator: Allocator<T1, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>> + Allocator<T2, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>> + Allocator<T2, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>,

fn to_superset( &self ) -> OMatrix<T2, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>

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

fn is_in_subset( m: &OMatrix<T2, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>> ) -> bool

Checks if element is actually part of the subset Self (and can be converted to it).

fn from_superset_unchecked( m: &OMatrix<T2, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>> ) -> Self

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

fn from_superset(element: &T) -> Option<Self>

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

impl<T1, T2, R1, R2, const D: usize> SubsetOf<Similarity<T2, R2, D>> for Similarity<T1, R1, D>

where T1: RealField + SubsetOf<T2>, T2: RealField + SupersetOf<T1>, R1: AbstractRotation<T1, D> + SubsetOf<R2>, R2: AbstractRotation<T2, D>,

fn to_superset(&self) -> Similarity<T2, R2, D>

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

fn is_in_subset(sim: &Similarity<T2, R2, D>) -> bool

Checks if element is actually part of the subset Self (and can be converted to it).

fn from_superset_unchecked(sim: &Similarity<T2, R2, D>) -> Self

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

fn from_superset(element: &T) -> Option<Self>

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

impl<T1, T2, R, C, const D: usize> SubsetOf<Transform<T2, C, D>> for Similarity<T1, R, D>

where T1: RealField, T2: RealField + SupersetOf<T1>, C: SuperTCategoryOf<TAffine>, R: AbstractRotation<T1, D> + SubsetOf<OMatrix<T1, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>> + SubsetOf<OMatrix<T2, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>>, Const<D>: DimNameAdd<U1> + DimMin<Const<D>, Output = Const<D>>, DefaultAllocator: Allocator<T1, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>> + Allocator<T2, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>> + Allocator<T2, DimNameSum<Const<D>, U1>, DimNameSum<Const<D>, U1>>,

fn to_superset(&self) -> Transform<T2, C, D>

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

fn is_in_subset(t: &Transform<T2, C, D>) -> bool

Checks if element is actually part of the subset Self (and can be converted to it).

fn from_superset_unchecked(t: &Transform<T2, C, D>) -> Self

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

fn from_superset(element: &T) -> Option<Self>

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

impl<T: RealField, R, const D: usize> UlpsEq for Similarity<T, R, D>

where R: AbstractRotation<T, D> + UlpsEq<Epsilon = T::Epsilon>, T::Epsilon: Clone,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T: Copy, R: Copy, const D: usize> Copy for Similarity<T, R, D>

impl<T: SimdRealField, R, const D: usize> Eq for Similarity<T, R, D>

where R: AbstractRotation<T, D> + Eq,