v-wong / cubesimrs

Rust based Rubik's Cube simulation and solving library.

Hi There, I'm Vincent!

I'm a software engineer at Atlassian in Sydney, Australia. Before that, I studied applied mathematics and computer science at UNSW. While studying, I took up roles as:

• Software Engineer Intern at IMC Trading (December 2021 - February 2022).
• Casual Software Developer at Ventia (September 2019 - November 2021).

My detailed work history can be found on my resume.

Outside of work, I have worked on projects in a variety of languages including:

• Rust: CubeSimRS and ra-evaluator.
• Python: CubeSimPy and LZ78 Encoder.
• JavaScript/TypeScript: Huffman Encoding Visualiser and LinkUp Events.

When not coding, I like to speedcube and have held national championship podiums.

Contact Me

cubesimrs's Issues

Scramble parser should return Result

CubeSimRS/src/scramble_parser.rs

Line 47 in 92ffac3

panic!()

Should return Result instead of panicking, as the user can handle the error better.

Add #![forbid(unsafe_code)] to ensure everything is implemented in 100% safe Rust

Add #![forbid(unsafe_code)] to ensure everything is implemented in 100% safe Rust, and mention this in the README.

Convert GeometricMove's predicate to use unboxed closures

If a move's n value was passed when checking if a sticker satisfies the predicate, the predicate field can become
pub predicate: fn(&Sticker, u32) -> bool>, which is potentially cleaner/faster than the current boxed dyn implementation.

Facelet Cube Bottleneck

The current FaceletCube implementation is not as performant as I would like it to be. Since the results are cached, actual computations are rarely required. I suspect the bottleneck to lie in the actual caching mechanism.

Set MoveVariant's 'Standard' value to 1

CubeSimRS/src/generic_cube.rs

Line 194 in 720e8c6

Standard,

By setting MoveVariant's 'Standard' value to 1, it improves semantics, as

• Standard is equivalent to 1 clockwise turn,
• Double becomes 2 turns,
• Inverse becomes 3 turns, equivalent to 1 anticlockwise turn

This allows reduction/simplification of summed MoveVariants, and can simplify modify_move (geometric_cube/moves.rs) to

fn modify_move(mv: GeometricMove, variant: MoveVariant) -> GeometricMove {
    GeometricMove { angle: mv.angle * variant as f32, ..mv }
}

Now that this is a single argument function, I believe you can extract this function and implement it as part of the ``From`` trait.

Now that this is a single argument function, I believe you can extract this function and implement it as part of the From trait.

Originally posted by @V-Wong in #63 (comment)

Cubes created from FaceletCube::from(faces) are invalid

In cube.rs, the new function initializes as:

            .enumerate()
            .map(|(i, s)| (*s, i as u16))

Effectively adding the number of the position of the original vec inside as extra info.

While on the from function:

            faces: faces.iter().map(|f| (*f, 0)).collect(),

Sets all indices to zero.

As a result, calling cubesim::solve(&cube) will always return None for cubes that are created with the from function instead of new.

This makes impossible to use this library for arbitrary cubes where we don't know the rotations made to get into that position.

WCA permalink leads to docs.rs

CubeSimRS/src/generic_cube.rs

Line 126 in 720e8c6

/// [WCA regulations]: worldcubeassociation.org/regulations/#article-12-notation

Leads to doc.rs non-existent resource, in both docs.rs and rust-analyzer (VSCode Extension).

Cache pruning tables in Thistlethwaite solver

The pruning tables inside each phase of the Thislethwaite solver are constant and do not vary from call to call. At the moment, the tables are regenerated at each function call. This is inefficient and caching the tables would be preferable.

Change Mask To Use Solved Indices

The mask method in the Cube trait is intended to ignore certain stickers which can be useful for defining solvers of certain states (e.g. cross, first block, etc). The method however currently takes in a slice of indices within the current cube state. It would be much more useful if it were to take a slice of indices with respect to the original solved cube state.

Refactor Geometric Moves

The implementation of geometrics moves currently features a lot of duplicate code. This was originally done as a temporary solution to support arbitrary sized cubes. A more elegant solution with less duplicate code would be preferred here.

Arbitrary Size Cube Property Based Tests

We currently have tests for 2x2x2, 3x3x3 and 4x4x4 cubes. It would be good to have tests that can generalise up to any NxNxN size cube.

Move enum should have a method to extract its MoveVariant

e.g. pub fn get_variant(&self) -> MoveVariant.
It will be handy, and there are already instances in the codebase where it could be applied.

Fix tense inconsistencies in doc comments

I see some inconsistencies in tense (present and past) in some doc comments (currently detected in generic_cube.rs).
E.g.

/// Maps over the pieces of the cube, replacing each piece
/// according to the given mask function. 
fn mask(&self, mask: &dyn Fn(i32, Face) -> Face) -> Self;

/// Apply a move to a cube.
/// ...
fn apply_move(&self, mv: Move) -> Self;

Scramble parser improvements

parse_scramble should:

• trim the provided scramble
• split by whitespace (use split_whitespace instead of split(' ')
• return an empty Vec for a string with no moves, as it currently panics on this case

Refactor GeoCube with unsigned integers

The implementation of GeoCube currently features many i32s, where u32s would be more appropriate, such as the size field in the GeoCube struct, and other mentions of size as a parameter.
A better semantically-typed solution would be preferred here.

Refactor facelet_moves

Code readability can be improved by more intuitive variable names and/or comments.

Doc comment typo fix

Fix typo in

CubeSimRS/src/generic_cube.rs

Line 148 in d8c354e

/// Each Move must be tagged with a ``MoveVariant`` to completely a move.

- perhaps "Each Move must be tagged with a MoveVariant to completely represent a move."