New implementation, moved old to experiments/

1 files changed, 34 insertions, 8 deletions

diff --git a/src/cube.h b/src/cube.h
index b916f96..836bb5d 100644
--- a/src/cube.h
+++ b/src/cube.h
@@ -3,25 +3,51 @@ typedef enum {
         R, R2, R3, L, L2, L3,
         F, F2, F3, B, B2, B3
 } move_t;
+
 typedef struct {
-        uint64_t e;
-        uint64_t c;
+        uint8_t c[8];
+        uint8_t e[12];
 } cube_t;
 
 extern cube_t solvedcube;
-extern cube_t errorcube;
 
-bool isconsistent(cube_t);
-bool issolved(cube_t);
+/*
+The functions readcube() and writecube() use the following format.
+
+Each edge is represented by two letters denoting the sides it belongs to
+and one number denoting its orientation (0 oriented, 1 mis-oriented).
+Similarly, each corner is represented by three letters and a number
+(0 oriented, 1 twisted clockwise, 2 twisted counter-clockwise).
+Edge orientation is relative to the F / B axis, corner orientation is
+relative to the U / D axis.
+
+The pieces are ordered such that the solved cube looks like this:
+
+UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0
+UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0
+
+Whitespace (including newlines) between pieces is ignored when reading
+the cube, and a single whitespace character is added between pieces
+when writing.
+
+The cube after the moves R'U'F looks like this:
+
+FL1 BR0 DB0 UR1 UF0 UB0 DL0 FR0 UL1 DF1 BL0 DR0
+UBL1 DBR1 UFR2 DFR2 DFL2 UBL2 UFL2 DBL0
+
+More formats might be supported in the future.
+*/
 
 cube_t readcube(char *);
 void writecube(cube_t, char *);
 
+bool isconsistent(cube_t);
+bool equal(cube_t, cube_t);
+bool issolved(cube_t);
+bool iserror(cube_t);
+
 int readmoves(char *, move_t *);
 void writemoves(move_t *, int, char *);
 
 cube_t move(cube_t, move_t);
-
-/*
 cube_t inverse(cube_t);
-*/