# Struct nalgebra::Id
[−]

#[repr(C)]pub struct Id<O = Multiplicative> where O: Operator { /* fields omitted */ }

The universal identity element wrt. a given operator, usually noted `Id`

with a
context-dependent subscript.

By default, it is the multiplicative identity element. It represents the degenerate set containing only the identity element of any group-like structure. It has no dimension known at compile-time. All its operations are no-ops.

## Methods

`impl<O> Id<O> where O: Operator`

## Trait Implementations

`impl One for Id<Multiplicative>`

`impl<E> Translation<E> for Id<Multiplicative> where E: EuclideanSpace`

`fn to_vector(&self) -> E::Coordinates`

Converts this translation to a vector.

`fn from_vector(v: E::Coordinates) -> Option<Id<Multiplicative>>`

Attempts to convert a vector to this translation. Returns `None`

if the translation represented by `v`

is not part of the translation subgroup represented by `Self`

. Read more

`fn powf(&self, n: E::Real) -> Option<Self>`

Raises the translation to a power. The result must be equivalent to `self.to_superset() * n`

. Returns `None`

if the result is not representable by `Self`

. Read more

`fn translation_between(a: &E, b: &E) -> Option<Self>`

The translation needed to make `a`

coincide with `b`

, i.e., `b = a * translation_to(a, b)`

.

`impl<O> ApproxEq for Id<O> where O: Operator`

`type Epsilon = Id<O>`

Used for specifying relative comparisons.

`fn default_epsilon() -> Id<O>::Epsilon`

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

`fn default_max_relative() -> Id<O>::Epsilon`

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

`fn default_max_ulps() -> u32`

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

`fn relative_eq(&self, &Id<O>, Id<O>::Epsilon, Id<O>::Epsilon) -> bool`

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

`fn ulps_eq(&self, &Id<O>, Id<O>::Epsilon, u32) -> bool`

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

`fn relative_ne(&self,`

other: &Self,

epsilon: Self::Epsilon,

max_relative: Self::Epsilon)

-> bool

other: &Self,

epsilon: Self::Epsilon,

max_relative: Self::Epsilon)

-> bool

The inverse of `ApproxEq::relative_eq`

.

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

The inverse of `ApproxEq::ulps_eq`

.

`impl<E> OrthogonalTransformation<E> for Id<Multiplicative> where E: EuclideanSpace`

`impl<O> Clone for Id<O> where O: Operator`

`fn clone(&self) -> Id<O>`

Returns a copy of the value. Read more

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

1.0.0

Performs copy-assignment from `source`

. Read more

`impl<O> MeetSemilattice for Id<O> where O: Operator`

`impl AddAssign<Id<Multiplicative>> for Id<Multiplicative>`

`fn add_assign(&mut self, Id<Multiplicative>)`

The method for the `+=`

operator

`impl<E> Scaling<E> for Id<Multiplicative> where E: EuclideanSpace`

`impl<E> Similarity<E> for Id<Multiplicative> where E: EuclideanSpace`

`type Scaling = Id<Multiplicative>`

The type of the pure (uniform) scaling part of this similarity transformation.

`fn translation(&self) -> Id<Multiplicative>::Translation`

The pure translational component of this similarity transformation.

`fn rotation(&self) -> Id<Multiplicative>::Rotation`

The pure rotational component of this similarity transformation.

`fn scaling(&self) -> Id<Multiplicative>::Scaling`

The pure scaling component of this similarity transformation.

`fn translate_point(&self, pt: &E) -> E`

Applies this transformation's pure translational part to a point.

`fn rotate_point(&self, pt: &E) -> E`

Applies this transformation's pure rotational part to a point.

`fn scale_point(&self, pt: &E) -> E`

Applies this transformation's pure scaling part to a point.

`fn rotate_vector(&self, pt: &E::Coordinates) -> E::Coordinates`

Applies this transformation's pure rotational part to a vector.

`fn scale_vector(&self, pt: &E::Coordinates) -> E::Coordinates`

Applies this transformation's pure scaling part to a vector.

`fn inverse_translate_point(&self, pt: &E) -> E`

Applies this transformation inverse's pure translational part to a point.

`fn inverse_rotate_point(&self, pt: &E) -> E`

Applies this transformation inverse's pure rotational part to a point.

`fn inverse_scale_point(&self, pt: &E) -> E`

Applies this transformation inverse's pure scaling part to a point.

`fn inverse_rotate_vector(&self, pt: &E::Coordinates) -> E::Coordinates`

Applies this transformation inverse's pure rotational part to a vector.

`fn inverse_scale_vector(&self, pt: &E::Coordinates) -> E::Coordinates`

Applies this transformation inverse's pure scaling part to a vector.

`impl<O> AbstractQuasigroup<O> for Id<O> where O: Operator`

`fn prop_inv_is_latin_square_approx(args: (Self, Self)) -> bool where Self: ApproxEq`

Returns `true`

if latin squareness holds for the given arguments. Approximate equality is used for verifications. Read more

`fn prop_inv_is_latin_square(args: (Self, Self)) -> bool where Self: Eq`

Returns `true`

if latin squareness holds for the given arguments.

`impl<E> AffineTransformation<E> for Id<Multiplicative> where E: EuclideanSpace`

`type Rotation = Id<Multiplicative>`

Type of the first rotation to be applied.

`type NonUniformScaling = Id<Multiplicative>`

Type of the non-uniform scaling to be applied.

`type Translation = Id<Multiplicative>`

The type of the pure translation part of this affine transformation.

`fn decompose(&self)`

-> (Id<Multiplicative>, Id<Multiplicative>, Id<Multiplicative>, Id<Multiplicative>)

-> (Id<Multiplicative>, Id<Multiplicative>, Id<Multiplicative>, Id<Multiplicative>)

Decomposes this affine transformation into a rotation followed by a non-uniform scaling, followed by a rotation, followed by a translation. Read more

`fn append_translation(&self,`

&Id<Multiplicative>::Translation)

-> Id<Multiplicative>

&Id<Multiplicative>::Translation)

-> Id<Multiplicative>

Appends a translation to this similarity.

`fn prepend_translation(&self,`

&Id<Multiplicative>::Translation)

-> Id<Multiplicative>

&Id<Multiplicative>::Translation)

-> Id<Multiplicative>

Prepends a translation to this similarity.

`fn append_rotation(&self, &Id<Multiplicative>::Rotation) -> Id<Multiplicative>`

Appends a rotation to this similarity.

`fn prepend_rotation(&self, &Id<Multiplicative>::Rotation) -> Id<Multiplicative>`

Prepends a rotation to this similarity.

`fn append_scaling(&self,`

&Id<Multiplicative>::NonUniformScaling)

-> Id<Multiplicative>

&Id<Multiplicative>::NonUniformScaling)

-> Id<Multiplicative>

Appends a scaling factor to this similarity.

`fn prepend_scaling(&self,`

&Id<Multiplicative>::NonUniformScaling)

-> Id<Multiplicative>

&Id<Multiplicative>::NonUniformScaling)

-> Id<Multiplicative>

Prepends a scaling factor to this similarity.

`fn append_rotation_wrt_point(&self, r: &Self::Rotation, p: &E) -> Option<Self>`

Appends to this similarity a rotation centered at the point `p`

, i.e., this point is left invariant. Read more

`impl Add<Id<Multiplicative>> for Id<Multiplicative>`

`type Output = Id<Multiplicative>`

The resulting type after applying the `+`

operator

`fn add(self, Id<Multiplicative>) -> Id<Multiplicative>`

The method for the `+`

operator

`impl<E> Transformation<E> for Id<Multiplicative> where E: EuclideanSpace`

`fn transform_point(&self, pt: &E) -> E`

Applies this group's action on a point from the euclidean space.

`fn transform_vector(&self, v: &E::Coordinates) -> E::Coordinates`

Applies this group's action on a vector from the euclidean space. Read more

`impl Div<Id<Multiplicative>> for Id<Multiplicative>`

`type Output = Id<Multiplicative>`

The resulting type after applying the `/`

operator

`fn div(self, Id<Multiplicative>) -> Id<Multiplicative>`

The method for the `/`

operator

`impl Zero for Id<Multiplicative>`

`fn zero() -> Id<Multiplicative>`

Returns the additive identity element of `Self`

, `0`

. Read more

`fn is_zero(&self) -> bool`

Returns `true`

if `self`

is equal to the additive identity.

`impl<O> Debug for Id<O> where O: Operator + Debug`

`fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>`

Formats the value using the given formatter.

`impl MulAssign<Id<Multiplicative>> for Id<Multiplicative>`

`fn mul_assign(&mut self, Id<Multiplicative>)`

The method for the `*=`

operator

`impl<O, T> SubsetOf<T> for Id<O> where O: Operator,`

T: Identity<O> + PartialEq<T>

T: Identity<O> + PartialEq<T>

`fn to_superset(&self) -> T`

The inclusion map: converts `self`

to the equivalent element of its superset.

`fn is_in_subset(t: &T) -> bool`

Checks if `element`

is actually part of the subset `Self`

(and can be converted to it).

`unsafe fn from_superset_unchecked(&T) -> Id<O>`

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. Read more

`impl<O> Inverse<O> for Id<O> where O: Operator`

`fn inverse(&self) -> Id<O>`

Returns the inverse of `self`

, relative to the operator `O`

.

`fn inverse_mut(&mut self)`

In-place inversin of `self`

.

`impl<O> JoinSemilattice for Id<O> where O: Operator`

`impl<O> Copy for Id<O> where O: Operator`

`impl<O> AbstractGroup<O> for Id<O> where O: Operator`

`impl<O> Eq for Id<O> where O: Operator`

`impl<O> AbstractLoop<O> for Id<O> where O: Operator`

`impl Mul<Id<Multiplicative>> for Id<Multiplicative>`

`type Output = Id<Multiplicative>`

The resulting type after applying the `*`

operator

`fn mul(self, Id<Multiplicative>) -> Id<Multiplicative>`

The method for the `*`

operator

`impl DivAssign<Id<Multiplicative>> for Id<Multiplicative>`

`fn div_assign(&mut self, Id<Multiplicative>)`

The method for the `/=`

operator

`impl<O> PartialOrd<Id<O>> for Id<O> where O: Operator`

`fn partial_cmp(&self, &Id<O>) -> Option<Ordering>`

This method returns an ordering between `self`

and `other`

values if one exists. Read more

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

1.0.0

This method tests less than (for `self`

and `other`

) and is used by the `<`

operator. Read more

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

1.0.0

This method tests less than or equal to (for `self`

and `other`

) and is used by the `<=`

operator. Read more

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

1.0.0

This method tests greater than (for `self`

and `other`

) and is used by the `>`

operator. Read more

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

1.0.0

This method tests greater than or equal to (for `self`

and `other`

) and is used by the `>=`

operator. Read more

`impl<E> Isometry<E> for Id<Multiplicative> where E: EuclideanSpace`

`impl<O> Display for Id<O> where O: Operator`

`fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`

Formats the value using the given formatter. Read more

`impl<O> PartialEq<Id<O>> for Id<O> where O: Operator`

`fn eq(&self, &Id<O>) -> bool`

This method tests for `self`

and `other`

values to be equal, and is used by `==`

. Read more

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

1.0.0

This method tests for `!=`

.

`impl<E> ProjectiveTransformation<E> for Id<Multiplicative> where E: EuclideanSpace`

`fn inverse_transform_point(&self, pt: &E) -> E`

Applies this group's inverse action on a point from the euclidean space.

`fn inverse_transform_vector(&self, v: &E::Coordinates) -> E::Coordinates`

Applies this group's inverse action on a vector from the euclidean space. Read more

`impl<O> AbstractMagma<O> for Id<O> where O: Operator`

`fn operate(&self, &Id<O>) -> Id<O>`

Performs an operation.

`fn op(&self, O, lhs: &Self) -> Self`

Performs specific operation.

`impl<E> Rotation<E> for Id<Multiplicative> where E: EuclideanSpace`

`fn powf(&self, E::Real) -> Option<Id<Multiplicative>>`

Raises this rotation to a power. If this is a simple rotation, the result must be equivalent to multiplying the rotation angle by `n`

. Read more

`fn rotation_between(a: &E::Coordinates,`

b: &E::Coordinates)

-> Option<Id<Multiplicative>>

b: &E::Coordinates)

-> Option<Id<Multiplicative>>

Computes a simple rotation that makes the angle between `a`

and `b`

equal to zero, i.e., `b.angle(a * delta_rotation(a, b)) = 0`

. If `a`

and `b`

are collinear, the computed rotation may not be unique. Returns `None`

if no such simple rotation exists in the subgroup represented by `Self`

. Read more

`fn scaled_rotation_between(a: &E::Coordinates,`

b: &E::Coordinates,

E::Real)

-> Option<Id<Multiplicative>>

b: &E::Coordinates,

E::Real)

-> Option<Id<Multiplicative>>

Computes the rotation between `a`

and `b`

and raises it to the power `n`

. Read more

`impl<O> Lattice for Id<O> where O: Operator`

`fn meet_join(&self, other: &Self) -> (Self, Self)`

Returns the infimum and the supremum simultaneously.

`fn partial_min(&'a self, other: &'a Self) -> Option<&'a Self>`

Return the minimum of `self`

and `other`

if they are comparable.

`fn partial_max(&'a self, other: &'a Self) -> Option<&'a Self>`

Return the maximum of `self`

and `other`

if they are comparable.

`fn partial_sort2(&'a self, other: &'a Self) -> Option<(&'a Self, &'a Self)>`

Sorts two values in increasing order using a partial ordering.

`fn partial_clamp(&'a self, min: &'a Self, max: &'a Self) -> Option<&'a Self>`

Clamp `value`

between `min`

and `max`

. Returns `None`

if `value`

is not comparable to `min`

or `max`

. Read more

`impl<O> Identity<O> for Id<O> where O: Operator`

`impl<E> DirectIsometry<E> for Id<Multiplicative> where E: EuclideanSpace`

`impl<O> AbstractGroupAbelian<O> for Id<O> where O: Operator`

`fn prop_is_commutative_approx(args: (Self, Self)) -> bool where Self: ApproxEq`

Returns `true`

if the operator is commutative for the given argument tuple. Approximate equality is used for verifications. Read more

`fn prop_is_commutative(args: (Self, Self)) -> bool where Self: Eq`

Returns `true`

if the operator is commutative for the given argument tuple.

`impl<O> AbstractMonoid<O> for Id<O> where O: Operator`

`fn prop_operating_identity_element_is_noop_approx(a: Self) -> bool where Self: ApproxEq`

Checks whether operating with the identity element is a no-op for the given argument. Approximate equality is used for verifications. Read more

`fn prop_operating_identity_element_is_noop(a: Self) -> bool where Self: Eq`

Checks whether operating with the identity element is a no-op for the given argument. Read more

`impl<O> AbstractSemigroup<O> for Id<O> where O: Operator`

`fn prop_is_associative_approx(args: (Self, Self, Self)) -> bool where Self: ApproxEq`

Returns `true`

if associativity holds for the given arguments. Approximate equality is used for verifications. Read more

`fn prop_is_associative(args: (Self, Self, Self)) -> bool where Self: Eq`

Returns `true`

if associativity holds for the given arguments.