cubik 0.2.5

Fast Rubik's Cube engine with Python bindings

Cubik

C++ module for emulating a Rubik's cube and its behaviors for implementing solving algorithms, search algorithms, and more.

The Cube Model

For cube notation please refer to 3x3 Rubik's Cube Move Notation.

Memory Model

In this cube model we attempt to be as memory efficient as possible so, in memory each face is stored as a uint32 such that:

Unused	Bottom Right	Bottom Middle	Bottom Left	Middle Right	Center	Middle Left	Top Right	Top Middle	Top Left
b31	b30	b29	b28	b27	b26	b25	b24	b23	b22	b21	b20	b19	b18	b17	b16	b15	b14	b13	b12	b11	b10	b9	b8	b7	b6	b5	b4	b3	b2	b1	b0

Visualized/Printed Model

Cube Layout:

          +---------+
          |         |
          |    U    |
          |         |
+---------+---------+---------+---------+
|         |         |         |         |
|    L    |    F    |    R    |    B    |
|         |         |         |         |
+---------+---------+---------+---------+
          |         |
          |    D    |
          |         |
          +---------+

Letter	Face
U	Up
L	Left
F	Front
R	Right
B	Back
D	Down

Face Layout:

Top Left	Top Middle	Top Right
Middle Left	Center	Middle Right
Bottom Left	Bottom Middle	Bottom Right