Skip to main content

NxNxN Rubik Cube implementation

Project description

MagicCube: A NxNxN Rubik Cube implementation

A fast implementation of the Rubik Cube based in Python 3.x.

Makes it easy to create cubes of various sizes (2x2x2, 3x3x3, 4x4x4, 6x6x6, ...., 100x100x100).

Fast rotation speed when compared with other Python implementations, which makes it suitable for Rubik Cube simulations.

Includes:

  • Simple solver for the 3x3x3 cube.
  • Move optimizer which reduces the number of moves.

Installation

pip install magiccube

Usage

import magiccube

# 3x3x3 Cube
cube = magiccube.Cube(3,"YYYYYYYYYRRRRRRRRRGGGGGGGGGOOOOOOOOOBBBBBBBBBWWWWWWWWW")
print(cube)

Cube

# Rotate the cube
cube.rotate("R' L U D' F B' R' L")

# Solve the 3x3x3 cube
solver = BasicSolver(cube)
solver.solve()

# 6x6x6 Cube
cube = magiccube.Cube(6)
cube.rotate("Rw' Lw 3Uw'")

Examples

See examples folder.

Supported Moves and Notation

Basic moves

Move
L L' Clockwise/Counterclockwise cube rotation of the LEFT face.
R R' Clockwise/Counterclockwise cube rotation of the RIGHT face.
D D' Clockwise/Counterclockwise cube rotation of the DOWN face.
U U' Clockwise/Counterclockwise cube rotation of the UP face.
F F' Clockwise/Counterclockwise cube rotation of the FRONT face.
B B' Clockwise/Counterclockwise cube rotation of the BACK face.

Advanced Moves

Move
X X' Cube rotation on X axis. X is the axis that points from LEFT to the RIGHT face.
Y Y' Cube rotation on Y axis. Y is the axis that points from DOWN to the UP face.
Z Z' Cube rotation on Z axis. Z is the axis that points from BACK to the FRONT face.
M M' Rotation of the center layer on the X axis.
E E' Rotation of the center layer on the Y axis.
S S' Rotation of the center layer on the Z axis.
Fw Fw' Wide rotation of 2 layers.
3Fw 3Fw' Wide rotation of 3 layers.
3F 3F' Rotation of the 3rd layer.

Cube Coordinates

  • Cube coordinates are expressed as a tuple of x,y,z.
  • (0,0,0) is the piece on the LEFT,DOWN,BACK corner.
  • In a 3x3x3, (2,2,2) is the piece on the RIGH,UP,FRONT corner.

Solver

The solver uses the beginner method to solve the cube

Move Optimizer

The move optimizer does the following optimizations:

  • Eliminates redundant moves (ex: L L L L)
  • Converts 3x moves to the inverse (ex: F F F -> F')
  • Eliminates cube rotations (ex: Y F -> R)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

magiccube-0.0.7.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

magiccube-0.0.7-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file magiccube-0.0.7.tar.gz.

File metadata

  • Download URL: magiccube-0.0.7.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for magiccube-0.0.7.tar.gz
Algorithm Hash digest
SHA256 a069a3a59ee9ea010611d345e5a39ec88fdecc2b786f5340e77048edc97ac940
MD5 dfac3a64ebe6121b8121aaeb1c6d9e7d
BLAKE2b-256 a1b1879310e4bb08f98f72329c1811a54fc553f1a02b01d320c8bcb10ca0a66e

See more details on using hashes here.

File details

Details for the file magiccube-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: magiccube-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for magiccube-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 fe04375019f1556eb09199ce47d8e3017e14aa651504dafdfb8f322bf42eba76
MD5 57d9954a8d6e329ff9d97fe266f6284b
BLAKE2b-256 2bf9d78b765a0fcc0c578de0ee385d552305739c4959f98107332f0ed9d59eae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page