Struct CubeSurfacePoint 

pub struct CubeSurfacePoint<const BIG_LUTS: bool>(pub CubeSurfacePoint);

A helper wrapper-type around a CubeSurfacePoint that operates using look-up tables.

A luts::CubeSurfacePoint::<false> only has LUTs 48 bytes long, but might need more than one look-up for each operation. A luts::CubeSurfacePoint::<true>, in contrast, has LUTs up to 2304 bytes long, but only ever needs one look-up per operation.

Tuple Fields

0: CubeSurfacePoint

Implementations

impl<const BIG_LUTS: bool> CubeSurfacePoint<BIG_LUTS>

pub const REFERENCE_POINT: Self

Please refer to the ordinary REFERENCE_POINT.

pub const fn direction(self) -> Direction

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

impl CubeSurfacePoint<false>

pub const fn one_right_angle_cw(self) -> Self

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

pub const fn one_right_angle_acw(self) -> Self

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

pub const fn beside(self) -> Self

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

pub const fn opposite(self) -> Self

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

pub const fn opposite_then_beside(self) -> Self

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

pub const fn flip_sign_of_2(self) -> Self

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

pub const fn flip_2_and_3(self) -> Self

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

pub const fn n_right_angles<const CLOCKWISE: bool>(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 n_right_angles_cw(self, angle: u8) -> Self

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

impl CubeSurfacePoint<true>

pub const fn one_right_angle_cw(self) -> Self

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

pub const fn one_right_angle_acw(self) -> Self

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

pub const fn beside(self) -> Self

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

pub const fn opposite(self) -> Self

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

pub const fn opposite_then_beside(self) -> Self

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

pub const fn flip_sign_of_2(self) -> Self

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

pub const fn flip_2_and_3(self) -> Self

Please refer to the function of the same name in the basic 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 fn div_alt(self, divisor: Self) -> Rotation

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<const BIG_LUTS: bool> Clone for CubeSurfacePoint<BIG_LUTS>

fn clone(&self) -> CubeSurfacePoint<BIG_LUTS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const BIG_LUTS: bool> Debug for CubeSurfacePoint<BIG_LUTS>

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

Formats the value using the given formatter.

impl Div for CubeSurfacePoint<false>

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

type Output = Rotation

This rotation can be either proper or improper.

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

The operation occurs by finding the reciprocal of the divisor using a LUT, then rotating it according to self. The rotation happens Elementary-Reflection-by-Elementary-Reflection as usual, but each Elementary Reflection is performed with a LUT.

impl Div for CubeSurfacePoint<true>

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

type Output = Rotation

This rotation can be either proper or improper.

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

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

impl<const BIG_LUTS: bool> From<CubeSurfacePoint<BIG_LUTS>> for CubeSurfacePoint

fn from(x: CubeSurfacePoint<BIG_LUTS>) -> Self

Converts to this type from the input type.

impl From<CubeSurfacePoint<false>> for Rotation

fn from(corresponding_point: CubeSurfacePoint<false>) -> Self

Converts to this type from the input type.

impl From<CubeSurfacePoint<true>> for Rotation

fn from(corresponding_point: CubeSurfacePoint<true>) -> Self

Converts to this type from the input type.

impl<const BIG_LUTS: bool> From<CubeSurfacePoint> for CubeSurfacePoint<BIG_LUTS>

fn from(x: CratePt) -> Self

Converts to this type from the input type.

impl From<Rotation> for CubeSurfacePoint<false>

fn from(x: Rotation) -> Self

Converts to this type from the input type.

impl From<Rotation> for CubeSurfacePoint<true>

fn from(x: Rotation) -> Self

Converts to this type from the input type.

impl Mul<CubeSurfacePoint<false>> for Rotation

Rotates a copy of a given CubeSurfacePoint according to self.

type Output = CubeSurfacePoint<false>

Output same as input.

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

The rotation happens Elementary-Reflection-by-Elementary-Reflection as usual, but each Elementary Reflection is performed with a LUT.

impl Mul<CubeSurfacePoint<true>> for Rotation

Rotates a copy of a given CubeSurfacePoint according to self.

type Output = CubeSurfacePoint<true>

Output same as input.

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

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

impl Mul<ImproperRotation> for CubeSurfacePoint<false>

Rotates a copy of self according to an ImproperRotation. Switches Geometric Group.

type Output = CubeSurfacePoint<false>

Although the Geometric Group does change, CubeSurfacePoint does not change its data-type depending on Geometric Group. Thus the data-type remains the same.

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

The rotation happens Elementary-Reflection-by-Elementary-Reflection as usual, but each Elementary Reflection is performed with a LUT.

impl Mul<ImproperRotation> for CubeSurfacePoint<true>

Rotates a copy of self according to an ImproperRotation. Switches Geometric Group.

type Output = CubeSurfacePoint<true>

Although the Geometric Group does change, CubeSurfacePoint does not change its data-type depending on Geometric Group. Thus the data-type remains the same.

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

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

While this could have been implemented using smaller LUTs than the ones used for Mul<Rotation>, it was deemed a useless middle solution.

impl Mul<ProperRotation> for CubeSurfacePoint<false>

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

type Output = CubeSurfacePoint<false>

The Geometric Group doesn’t change. Even if it did, this data-type is group-agnostic.

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

The rotation happens Elementary-Reflection-by-Elementary-Reflection as usual, but each Elementary Reflection is performed with a LUT.

impl Mul<ProperRotation> for CubeSurfacePoint<true>

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

type Output = CubeSurfacePoint<true>

The Geometric Group doesn’t change. Even if it did, this data-type is group-agnostic.

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

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

While this could have been implemented using smaller LUTs than the ones used for Mul<Rotation>, it was deemed a useless middle solution.

impl Mul<Rotation> for CubeSurfacePoint<false>

Rotates a copy of self according to a Rotation.

type Output = CubeSurfacePoint<false>

We use the most general data-type possible, so the output does not change.

fn mul(self, rot: Rotation) -> Self::Output

The rotation happens Elementary-Reflection-by-Elementary-Reflection as usual, but each Elementary Reflection is performed with a LUT.

impl Mul<Rotation> for CubeSurfacePoint<true>

Rotates a copy of self according to a Rotation.

type Output = CubeSurfacePoint<true>

We use the most general data-type possible, so the output does not change.

fn mul(self, rot: Rotation) -> Self::Output

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

impl MulAssign<ImproperRotation> for CubeSurfacePoint<false>

Rotates self according to a ImproperRotation. Switches Geometric Group.

fn mul_assign(&mut self, x: ImproperRotation)

The data-type remains the same, despite the Geometric Group changing. Thus, the result can be directly assigned.

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

While this could have been implemented using smaller LUTs than the ones used for Mul<Rotation>, it was deemed a useless middle solution.

impl MulAssign<ImproperRotation> for CubeSurfacePoint<true>

Rotates self according to an ImproperRotation. Switches Geometric Group.

fn mul_assign(&mut self, x: ImproperRotation)

The data-type remains the same, despite the Geometric Group changing. Thus, the result can be directly assigned.

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

While this could have been implemented using smaller LUTs than the ones used for Mul<Rotation>, it was deemed a useless middle solution.

impl MulAssign<ProperRotation> for CubeSurfacePoint<false>

Rotates self according to a ProperRotation. Maintains Geometric Group.

fn mul_assign(&mut self, x: ProperRotation)

Neither the Geometric Group nor the data-type 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.

While this could have been implemented using smaller LUTs than the ones used for Mul<Rotation>, it was deemed a useless middle solution.

impl MulAssign<ProperRotation> for CubeSurfacePoint<true>

Rotates self according to a ProperRotation. Maintains Geometric Group.

fn mul_assign(&mut self, x: ProperRotation)

Neither the Geometric Group nor the data-type 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.

While this could have been implemented using smaller LUTs than the ones used for Mul<Rotation>, it was deemed a useless middle solution.

impl MulAssign<Rotation> for CubeSurfacePoint<false>

Rotates self according to a Rotation.

fn mul_assign(&mut self, rot: Rotation)

We use the most general data-type possible, so the output does not change. Thus, it can be directly assigned.

The rotation happens Elementary-Reflection-by-Elementary-Reflection as usual, but each Elementary Reflection is performed with a LUT.

impl MulAssign<Rotation> for CubeSurfacePoint<true>

Rotates self according to a Rotation.

fn mul_assign(&mut self, rot: Rotation)

We use the most general data-type possible, so the output does not change. Thus, it can be directly assigned.

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

impl OctahedrallySymmetricPoint for CubeSurfacePoint<false>

type OtherGroup = CubeSurfacePoint<false>

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 OctahedrallySymmetricPoint for CubeSurfacePoint<true>

type OtherGroup = CubeSurfacePoint<true>

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<const BIG_LUTS: bool> Ord for CubeSurfacePoint<BIG_LUTS>

fn cmp(&self, other: &CubeSurfacePoint<BIG_LUTS>) -> 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<const BIG_LUTS: bool> PartialEq for CubeSurfacePoint<BIG_LUTS>

fn eq(&self, other: &CubeSurfacePoint<BIG_LUTS>) -> 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<const BIG_LUTS: bool> PartialOrd for CubeSurfacePoint<BIG_LUTS>

fn partial_cmp(&self, other: &CubeSurfacePoint<BIG_LUTS>) -> 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<const BIG_LUTS: bool> Copy for CubeSurfacePoint<BIG_LUTS>

impl<const BIG_LUTS: bool> Eq for CubeSurfacePoint<BIG_LUTS>

impl<const BIG_LUTS: bool> StructuralPartialEq for CubeSurfacePoint<BIG_LUTS>