CubeSim is a Rubik's Cube simulator and solver written entirely in Rust.
The core types in the library are as follows:
- Cube trait: To support multiple implementations of a Rubik’s Cube, we define a trait which includes the minimal set of behaviours expected of a Rubik’s Cube. Specific implementations can then be used for different scenarios. For example, the FaceletCube is most performant while the GeoCube allows for easy 3D modelling.
- Face enum: A face of a Rubik’s Cube sticker represented in WCA notation.
- Move enum: A move of a 3x3x3 Rubik’s Cube represented in WCA notation. Each Move must be tagged with a MoveVariant to completely define a move.
- MoveVariant enum: A move variation that must be applied to the Move enum.
After understanding these core types, we can start writing a basic simulation:
```rs use cubesim::prelude::{Cube, Face, Move, MoveVariant}; use cubesim::cube_implementors::FaceletCube;
let cube = FaceletCube::new(3); let turnedcube = cube.applymove(Move::U(MoveVariant::Double)); println!("{:?}", turnedcube.getstate()); ```
To build more complex simulations and solvers, please follow our official documentation.