Struct ReferenceGroupPoint 

pub struct ReferenceGroupPoint(pub ReferenceGroupPoint);

As per the basic ReferenceGroupPoint. Each LUT used is up to 576 bytes in length, and each operation is guaranteed to consist of a single look-up.

Tuple Fields

0: ReferenceGroupPoint

Implementations

impl ReferenceGroupPoint

pub const fn direction(self) -> Direction

Please refer to the function of the same name in 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 flip_sign_of_2(self) -> OppositeGroupPoint

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

pub const fn opposite_then_beside(self) -> ReferenceGroupPoint

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

pub const fn flip_2_and_3(self) -> ReferenceGroupPoint

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

pub const fn one_right_angle_cw(self) -> ReferenceGroupPoint

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

pub const fn one_right_angle_acw(self) -> ReferenceGroupPoint

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 div_prop(self, other: ReferenceGroupPoint) -> ProperRotation

Please refer to the function of the same name in the basic ReferenceGroupPoint.

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

Please refer to the function of the same name in the basic ReferenceGroupPoint.

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

Please refer to the function of the same name in the basic ReferenceGroupPoint.

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

Please refer to the function of the same name in the basic ReferenceGroupPoint.

pub fn div_alt(self, x: Self) -> ProperRotation

An alternative implementation of division, that uses the same big LUT as multiplication does, but performs two look-ups instead of one.

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 divisorpoint ends up coinciding withself`, ie the dividend.

type Output = ImproperRotation

This operation needs an improper rotation.

fn div(self, x: OppositeGroupPoint) -> Self::Output

A look-up on a 2-D LUT produces the result directly.

impl Div<ReferenceGroupPoint> for OppositeGroupPoint

Extracts the improper rotation that must occur so that the divisorpoint ends up coinciding withself`, ie the dividend.

type Output = ImproperRotation

This operation needs an improper rotation.

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

A look-up on a 2-D LUT produces the result directly.

impl Div for ReferenceGroupPoint

Extracts the proper rotation that must occur so that the divisorpoint ends up coinciding withself`, ie the dividend.

type Output = ProperRotation

A proper rotation is enough for this operation.

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

A look-up on a 2-D LUT produces the result directly.

impl From<ProperRotation> for ReferenceGroupPoint

fn from(x: ProperRotation) -> Self

Converts to this type from the input type.

impl From<ReferenceGroupPoint> for CratePt

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

fn from(x: ReferenceGroupPoint) -> CratePt

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 according to an ImproperRotation. Switches Geometric Group.

type Output = OppositeGroupPoint

Output belongs to the other Geometric Group.

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

The ImproperRotation is not examined bit-by-bit. Instead, a look-up on a 2-D LUT produces the result directly.

impl Mul<ProperRotation> for ReferenceGroupPoint

Rotates a copy of self according to a ProperRotation. Maintains Geometric Group.

type Output = ReferenceGroupPoint

Output belongs to the same Geometric Group.

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

The ProperRotation is not examined bit-by-bit. Instead, a look-up on a 2-D LUT produces the result directly.

impl Mul<ReferenceGroupPoint> for ImproperRotation

type Output = OppositeGroupPoint

Output belongs to the other Geometric Group.

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

The ImproperRotation is not examined bit-by-bit. Instead, a look-up on a 2-D LUT produces the result directly.

impl Mul<ReferenceGroupPoint> for ProperRotation

type Output = ReferenceGroupPoint

Output belongs to the same Geometric Group.

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

The ProperRotation is not examined bit-by-bit. Instead, a look-up on a 2-D LUT produces the result directly.

impl MulAssign<ProperRotation> for ReferenceGroupPoint

Rotates self according to a ProperRotation. Maintains Geometric Group.

fn mul_assign(&mut self, x: ProperRotation)

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

The ProperRotation is not examined bit-by-bit. Instead, a look-up on a 2-D LUT produces the result directly.

impl OctahedrallySymmetricPoint for ReferenceGroupPoint

type OtherGroup = OppositeGroupPoint

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

fn beside(self) -> Self::OtherGroup

Returns the other point found in the same edge of the same face of the cube.

fn opposite(self) -> Self::OtherGroup

Returns the point in the corresponding position of the opposite face of the cube.

fn opposite_then_beside(self) -> Self

Functionally identical to self.opposite().beside(). Also available with the words swapped, as the order doesn’t matter.

fn one_right_angle_cw(self) -> Self

Returns the point which is positioned 90° clockwise from self, as viewed from the face on which both are located.

fn one_right_angle_acw(self) -> Self

Returns the point which is positioned 90° anti-clockwise from self, as viewed from the face on which both are located.

fn flip_sign_of_2(self) -> Self::OtherGroup

Flips the sign of the coördinate whose absolute value is 2.

fn flip_2_and_3(self) -> Self

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

fn direction(self) -> Direction

Returns the spatial direction towards which self is oriented.

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

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

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

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

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 crate::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: CratePt) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ReferenceGroupPoint

impl Eq for ReferenceGroupPoint

impl StructuralPartialEq for ReferenceGroupPoint