Giter Club home page Giter Club logo

cube-notation-compiler's Introduction

Cube Notation Compiler

Version 1.0

Status for V2: Creating Parser (Hacked (S)LR Parser)

This Ruby script compiles the Extended Singmaster Notation for the Rubik's cube into a simpler notation. The Extended Singmaster Notation is further explained in notation.md. In the simplified notation, there are no parentheses, and a turn is always paired with the number of times the turn would be done. The grammar used for the lexer and the parser is in grammar.md. This compiler is originally written for the Cubing Analysis and Testing Suite (cats).

Known Issues and Possible Improvements

Here are some current issues with the project:

  • Does not support face slice and anti-slice moves, conjugates, and commutators yet
  • Has not been refactored and optimized therefore it has a lot of code smell and can be made shorter (possibly down to 200 lines from 413 lines).
  • Can possibly skip and merge some steps like code optimization since the grammar is simple.
  • Uses Ruby, which might be an issue for some people due to it being an interpreted language.
  • Determining the modularity/period of an algorithm can make the program compile faster.
  • Has not been tested or validated fully yet

Getting Started

The compiler is originally written for software that doesn't use Ruby, so it requires an external file called '.input' that contains a string of moves. The output would be the simplified string of moves stored in the file '.output'. It is important to note that the program deletes the input file afterwards.

License

This project is licensed under the BSD 3-Clause Clear License (License.MD would be uploaded later).

cube-notation-compiler's People

Contributors

afront avatar soutaro avatar

Watchers

 avatar  avatar

Forkers

soutaro

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.