#puzzle #solving #rubik #wca

cubing

Features from cubing.js in Rust

47 releases

0.13.10 Nov 1, 2024
0.13.7 Oct 30, 2024
0.13.0 Jan 15, 2024
0.12.4 Dec 26, 2023
0.1.2 May 3, 2021

#2 in #rubik

Download history 9/week @ 2024-07-21 72/week @ 2024-07-28 18/week @ 2024-08-25 6/week @ 2024-09-01 69/week @ 2024-09-08 262/week @ 2024-09-22 215/week @ 2024-09-29 278/week @ 2024-10-06 268/week @ 2024-10-13 41/week @ 2024-10-20 693/week @ 2024-10-27 156/week @ 2024-11-03

1,169 downloads per month
Used in 3 crates

MPL-2.0 license

120KB
2.5K SLoC

cubing.rs

Features from cubing.js in Rust.

Structure

See https://docs.rs/cubing/latest/cubing/ for Rust docs.

A subset of the cubing.js API is implemented under:

  • cubing::alg
  • cubing::kpuzzle
  • cubing::puzzles

Most applications will use str.parse::<Alg>() and KPuzzle as entry points into the API:

use cubing::{alg::parse_alg, puzzles::cube3x3x3_kpuzzle};

pub fn main() {
    let kpuzzle = cube3x3x3_kpuzzle();
    let default_pattern = kpuzzle.default_pattern();

    let input_alg = parse_alg!("R U R' F' U2 L' U' L F U2");

    let input_pattern = default_pattern
        .apply_alg(&input_alg)
        .expect("Input alg is not valid for puzzle.");
    println!(
        "The following alg {} the puzzle to its original pattern (including center orientation): {}",
        if default_pattern == input_pattern { "returns" } else { "does NOT return" },
        input_alg,
    )
}

Development

This repository contains a port of f2lfast that is useful for exercising functionality (although it's not yet at full speed):

cargo run --example f2lfast -- --scramble "U2 F2 U' L' U L D2 F D2 B' D2 B D2 L2 B L2 F"

Run tests using:

make test

Dependencies

~1.5–2.4MB
~50K SLoC