Enum ReferenceGroupPoint 

#[repr(u8)]
pub enum ReferenceGroupPoint {
    PosOnePosTwoPosThree = 0,
    PosOneNegTwoNegThree = 3,
    NegOnePosTwoNegThree = 5,
    NegOneNegTwoPosThree = 6,
    PosThreePosTwoNegOne = 9,
    PosThreeNegTwoPosOne = 10,
    NegThreePosTwoPosOne = 12,
    NegThreeNegTwoNegOne = 15,
    PosOnePosThreeNegTwo = 17,
    PosOneNegThreePosTwo = 18,
    NegOnePosThreePosTwo = 20,
    NegOneNegThreeNegTwo = 23,
    PosThreePosOnePosTwo = 24,
    PosThreeNegOneNegTwo = 27,
    NegThreePosOneNegTwo = 29,
    NegThreeNegOnePosTwo = 30,
    PosTwoPosOneNegThree = 33,
    PosTwoNegOnePosThree = 34,
    NegTwoPosOnePosThree = 36,
    NegTwoNegOneNegThree = 39,
    PosTwoPosThreePosOne = 40,
    PosTwoNegThreeNegOne = 43,
    NegTwoPosThreeNegOne = 45,
    NegTwoNegThreePosOne = 46,
}

The set of CubeSurfacePoints that can be made to coincide with the Reference Point using just one proper rotation.

Not coincidentally, their binary representations all have an even number of ones.

Variants

PosOnePosTwoPosThree = 0

The point [1, 2, 3]. Also the Point of Reference. Divided by itself, it yields –unsurprisingly enough– the identity operation.

PosOneNegTwoNegThree = 3

The point [1, -2, -3]. Divided by the Reference Point, it yields a rotation of 180° around the x axis.

NegOnePosTwoNegThree = 5

The point [-1, 2, -3]. Divided by the Reference Point, it yields a rotation of 180° around the y axis.

NegOneNegTwoPosThree = 6

The point [-1, -2, 3]. Divided by the Reference Point, it yields a rotation of 180° around the z axis.

PosThreePosTwoNegOne = 9

The point [3, 2, -1]. Divided by the Reference Point, it yields a rotation of 90° around the y axis.

PosThreeNegTwoPosOne = 10

The point [3, -2, 1]. Divided by the Reference Point, it yields a rotation of 180° around the y = 0, z = x axis.

NegThreePosTwoPosOne = 12

The point [-3, 2, 1]. Divided by the Reference Point, it yields a rotation of -90° around the y axis.

NegThreeNegTwoNegOne = 15

The point [-3, -2, -1]. Divided by the Reference Point, it yields a rotation of 180° around the y = 0, z = -x axis.

PosOnePosThreeNegTwo = 17

The point [1, 3, -2]. Divided by the Reference Point, it yields a rotation of -90° around the x axis.

PosOneNegThreePosTwo = 18

The point [1, -3, 2]. Divided by the Reference Point, it yields a rotation of 90° around the x axis.

NegOnePosThreePosTwo = 20

The point [-1, 3, 2]. Divided by the Reference Point, it yields a rotation of 180° around the x = 0, y = z axis.

NegOneNegThreeNegTwo = 23

The point [-1, -3, -2]. Divided by the Reference Point, it yields a rotation of 180° around the x = 0, y = -z axis.

PosThreePosOnePosTwo = 24

The point [3, 1, 2]. Divided by the Reference Point, it yields a rotation of 120° around the x = y = z axis.

PosThreeNegOneNegTwo = 27

The point [3, -1, -2]. Divided by the Reference Point, it yields a rotation of -120° around the x = -y = z axis.

NegThreePosOneNegTwo = 29

The point [-3, 1, -2]. Divided by the Reference Point, it yields a rotation of -120° around the x = y = -z axis.

NegThreeNegOnePosTwo = 30

The point [-3, -1, 2]. Divided by the Reference Point, it yields a rotation of 120° around the x = -y = -z axis.

PosTwoPosOneNegThree = 33

The point [2, 1, -3]. Divided by the Reference Point, it yields a rotation of 180° around the z = 0, x = y axis.

PosTwoNegOnePosThree = 34

The point [2, -1, 3]. Divided by the Reference Point, it yields a rotation of -90° around the z axis.

NegTwoPosOnePosThree = 36

The point [-2, 1, 3]. Divided by the Reference Point, it yields a rotation of 90° around the z axis.

NegTwoNegOneNegThree = 39

The point [-2, -1, -3]. Divided by the Reference Point, it yields a rotation of 180° around the z = 0, x = -y axis.

PosTwoPosThreePosOne = 40

The point [2, 3, 1]. Divided by the Reference Point, it yields a rotation of -120° around the x = y = z axis.

PosTwoNegThreeNegOne = 43

The point [2, -3, -1]. Divided by the Reference Point, it yields a rotation of 120° around the x = y = -z axis.

NegTwoPosThreeNegOne = 45

The point [-2, 3, -1]. Divided by the Reference Point, it yields a rotation of -120° around the x = -y = -z axis.

NegTwoNegThreePosOne = 46

The point [-2, -3, 1]. Divided by the Reference Point, it yields a rotation of 120° around the x = -y = z axis.

Implementations

impl ReferenceGroupPoint

pub const fn downcast(self) -> CubeSurfacePoint

Down-casts one ReferenceGroupPoint to a CubeSurfacePoint.

pub const fn beside(self) -> OppositeGroupPoint

Please refer to the function of the same name in CubeSurfacePoint.

pub const fn opposite(self) -> OppositeGroupPoint

Please refer to the function of the same name in CubeSurfacePoint.

pub const fn opposite_then_beside(self) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

pub const fn one_right_angle_cw(self) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

pub const fn one_right_angle_acw(self) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

pub const fn flip_sign_of_2(self) -> OppositeGroupPoint

Please refer to the function of the same name in CubeSurfacePoint.

pub const fn flip_2_and_3(self) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

pub const fn n_right_angles_cw(self, angle: u8) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

pub const fn n_right_angles_acw(self, angle: u8) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

pub const fn mul_prop(self, other: ProperRotation) -> ReferenceGroupPoint

Multiplies one ReferenceGroupPoint with one ProperRotation, producing one ReferenceGroupPoint as a result. Useful for static confirmation of Geometric Groups.

pub const fn mul_improp(self, other: ImproperRotation) -> OppositeGroupPoint

Multiplies one ReferenceGroupPoint with one ImproperRotation, producing one OppositeGroupPoint as a result. Useful for static confirmation of Geometric Groups.

pub const fn div_prop(self, other: ReferenceGroupPoint) -> ProperRotation

Divides one ReferenceGroupPoint by one ReferenceGroupPoint, producing one ProperRotation as a result. Useful for static confirmation of Geometric Group.

pub const fn div_improp(self, other: OppositeGroupPoint) -> ImproperRotation

Divides one ReferenceGroupPoint by one OppositeGroupPoint, producing one ImproperRotation as a result. Useful for static confirmation of Geometric Group.

pub const fn direction(self) -> Direction

Please refer to the function of the same name in CubeSurfacePoint.

Trait Implementations

impl Clone for ReferenceGroupPoint

fn clone(&self) -> ReferenceGroupPoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceGroupPoint

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

Formats the value using the given formatter.

impl Div<OppositeGroupPoint> for ReferenceGroupPoint

Extracts the improper rotation that must occur so that the divisor point ends up coinciding with self, ie the dividend.

type Output = ImproperRotation

This operation needs an improper rotation.

fn div(self, other: OppositeGroupPoint) -> ImproperRotation

Divides one Self by one OppositeGroupPoint, producing one ImproperRotation as a result. Useful for static confirmation of Geometric Group.

impl Div<ReferenceGroupPoint> for OppositeGroupPoint

Extracts the improper rotation that must occur so that the divisor point ends up coinciding with self, ie the dividend.

type Output = ImproperRotation

This operation needs an improper rotation.

fn div(self, other: ReferenceGroupPoint) -> ImproperRotation

Divides one Self by one ReferenceGroupPoint, producing one ImproperRotation as a result. Useful for static confirmation of Geometric Group.

impl Div for ReferenceGroupPoint

Extracts the proper rotation that must occur so that the divisor point ends up coinciding with self, ie the dividend.

type Output = ProperRotation

A proper rotation is enough for this operation.

fn div(self, other: Self) -> ProperRotation

Divides one Self by one Self, producing one ProperRotation as a result. Useful for static confirmation of Geometric Group.

impl From<ProperRotation> for ReferenceGroupPoint

fn from(x: ProperRotation) -> Self

Converts to this type from the input type.

impl From<ReferenceGroupPoint> for CubeSurfacePoint

Discards any knowledge of Geometric Group, producing a general CubeSurfacePoint.

fn from(x: ReferenceGroupPoint) -> Self

Converts to this type from the input type.

impl From<ReferenceGroupPoint> for ProperRotation

fn from(corresponding_point: ReferenceGroupPoint) -> Self

Converts to this type from the input type.

impl Mul<ImproperRotation> for ReferenceGroupPoint

Rotates a copy of self in a way that switches its Geometric Group.

type Output = OppositeGroupPoint

Output belongs to the other Geometric Group.

fn mul(self, other: ImproperRotation) -> OppositeGroupPoint

Multiplies one ReferenceGroupPoint with one ImproperRotation, producing one OppositeGroupPoint as a result. Useful for static confirmation of Geometric Groups.

impl Mul<ProperRotation> for ReferenceGroupPoint

Rotates a copy of self in a way that maintains its Geometric Group.

type Output = ReferenceGroupPoint

Same Geometric Group, so same data-type.

fn mul(self, other: ProperRotation) -> ReferenceGroupPoint

Multiplies one ReferenceGroupPoint with one ProperRotation, producing one ReferenceGroupPoint as a result. Useful for static confirmation of Geometric Groups.

impl Mul<ReferenceGroupPoint> for ImproperRotation

Rotates a copy the argument in a way that switches its Geometric Group.

type Output = OppositeGroupPoint

Output belongs to the other Geometric Group.

fn mul(self, x: ReferenceGroupPoint) -> Self::Output

Performs the * operation.

impl Mul<ReferenceGroupPoint> for ProperRotation

Rotates a copy the argument in a way that maintains its Geometric Group.

type Output = ReferenceGroupPoint

Same Geometric Group, so same data-type.

fn mul(self, x: ReferenceGroupPoint) -> Self::Output

Performs the * operation.

impl MulAssign<ProperRotation> for ReferenceGroupPoint

Rotates self in a way that maintains its Geometric Group.

fn mul_assign(&mut self, x: ProperRotation)

The data-type doesn’t change, so the result can be directly assigned.

impl OctahedrallySymmetricPoint for ReferenceGroupPoint

fn beside(self) -> Self::OtherGroup

Please refer to the function of the same name in CubeSurfacePoint.

fn opposite(self) -> Self::OtherGroup

Please refer to the function of the same name in CubeSurfacePoint.

fn flip_sign_of_2(self) -> Self::OtherGroup

Please refer to the function of the same name in CubeSurfacePoint.

fn opposite_then_beside(self) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

fn flip_2_and_3(self) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

fn one_right_angle_cw(self) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

fn one_right_angle_acw(self) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

fn n_right_angles_cw(self, angle: u8) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

fn n_right_angles_acw(self, angle: u8) -> Self

Please refer to the function of the same name in CubeSurfacePoint.

type OtherGroup = OppositeGroupPoint

The geometric group mirror to the one to which self belongs.

fn direction(self) -> Direction

Returns the spatial direction towards which self is oriented.

fn odd_ones(self) -> bool

Counts how many ones there are in the binary representation of a certain point, so it can be judged in which geometric group it belongs.

fn even_ones(self) -> bool

Equal to the negation of Self::odd_ones by definition.

fn n_right_angles<const CLOCKWISE: bool>(self, angle: u8) -> Self

Returns the point which is positioned (n * 90)° from self, as viewed from the face on which both are located.

fn beside_then_opposite(self) -> Self

Different name for CubeSurfacePoint::opposite_then_beside.

fn flip_1_and_3(self) -> Self

Different name for CubeSurfacePoint::opposite_then_beside.

fn flip_sign_of_1(self) -> Self::OtherGroup

Different name for CubeSurfacePoint::beside

fn flip_sign_of_3(self) -> Self::OtherGroup

Different name for CubeSurfacePoint::opposite

fn flip_1_and_2(self) -> Self

Flips the sign of the coördinates whose absolute values are 1 and 2.

impl Ord for ReferenceGroupPoint

fn cmp(&self, other: &ReferenceGroupPoint) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ReferenceGroupPoint

fn eq(&self, other: &ReferenceGroupPoint) -> 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 PartialOrd for ReferenceGroupPoint

fn partial_cmp(&self, other: &ReferenceGroupPoint) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<CubeSurfacePoint> for ReferenceGroupPoint

Please refer to CubeSurfacePoint::determine_group.

type Error = OppositeGroupPoint

If a certain CubeSurfacePoint does not belong to the ReferenceGroupPoints, it must by necessity belong to the OppositeGroupPoints.

fn try_from(x: CubeSurfacePoint) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ReferenceGroupPoint

impl Eq for ReferenceGroupPoint

impl StructuralPartialEq for ReferenceGroupPoint