Added API function for solution variations

2 files changed, 67 insertions, 19 deletions

diff --git a/python/examples/variations.py b/python/examples/variations.py
new file mode 100644
index 0000000..1b85d32
--- /dev/null
+++ b/python/examples/variations.py
@@ -0,0 +1,12 @@
+# Small example of nissy_python_module usage
+# See the solve.py example for more details on how this works
+
+from sys import path
+path.append("./")
+import nissy_python_module as nissy
+
+moves = "R U' Bw2 M D' x' F B(E2 F D B' Lw2 U2 U' S2 B)"
+
+print("Changing the last quarter turns of {} gives:".format(moves))
+for s in nissy.variations(moves, "lastqt"):
+        print(s)
diff --git a/python/nissy_module.c b/python/nissy_module.c
index a86b23f..88109d3 100644
--- a/python/nissy_module.c
+++ b/python/nissy_module.c
@@ -44,6 +44,29 @@ string_result(long long err, const char *result)
 }
 
 static PyObject *
+stringlist_result(long long err, char *result)
+{
+        int i, j, k;
+        PyObject *list, *item;
+
+        if(!check_error(err)) {
+                return NULL;
+        } else {
+                list = PyList_New(err);
+                for (i = 0, j = 0, k = 0; result[i] != 0; i++) {
+                        if (result[i] != '\n')
+                                continue;
+                        result[i] = 0;
+                        item = PyUnicode_FromString(&result[k]);
+                        PyList_SetItem(list, j, item);
+                        j++;
+                        k = i+1;
+                }
+                return list;
+        }
+}
+
+static PyObject *
 string_result_free(long long err, char *result)
 {
         PyObject *ret;
@@ -287,12 +310,11 @@ solve(PyObject *self, PyObject *args)
 {
         long long result;
         unsigned nissflag, minmoves, maxmoves, maxsolutions;
-        int optimal, i, j, k, threads;
+        int optimal, threads;
         const char *cube, *solver;
         char solutions[MAX_SOLUTIONS_SIZE];
         long long stats[NISSY_SIZE_SOLVE_STATS];
         PyByteArrayObject *data;
-        PyObject *list, *item;
 
         if (!PyArg_ParseTuple(args, "ssIIIIIIY", &cube, &solver, &nissflag,
              &minmoves, &maxmoves, &maxsolutions, &optimal, &threads, &data))
@@ -305,21 +327,7 @@ solve(PyObject *self, PyObject *args)
             stats, NULL, NULL);
         Py_END_ALLOW_THREADS
 
-        if(!check_error(result)) {
-                return NULL;
-        } else {
-                list = PyList_New(result);
-                for (i = 0, j = 0, k = 0; solutions[i] != 0; i++) {
-                        if (solutions[i] != '\n')
-                                continue;
-                        solutions[i] = 0;
-                        item = PyUnicode_FromString(&solutions[k]);
-                        PyList_SetItem(list, j, item);
-                        j++;
-                        k = i+1;
-                }
-                return list;
-        }
+        return stringlist_result(result, solutions);
 }
 
 PyDoc_STRVAR(countmoves_doc,
@@ -368,8 +376,9 @@ comparemoves(PyObject *self, PyObject *args)
         if (!PyArg_ParseTuple(args, "ss", &m1, &m2))
                 return NULL;
 
-        if ((cmp = nissy_comparemoves(m1, m2)) < 0)
-                return long_result(cmp);
+        cmp = nissy_comparemoves(m1, m2);
+        if (!check_error(cmp))
+                return NULL;
 
         switch (cmp) {
         case NISSY_COMPARE_MOVES_EQUAL:
@@ -381,6 +390,32 @@ comparemoves(PyObject *self, PyObject *args)
         }
 }
 
+PyDoc_STRVAR(variations_doc,
+"variations(moves, variation)\n"
+"--\n\n"
+"Find variations of a given move sequence\n"
+"\n"
+"Parameters:\n"
+"  - moves: the moves\n"
+"  - variation: the variation to apply, such as 'unniss' or 'lastqt'\n"
+"\n"
+"Returns: a list of move sequences, the variation of the given moves.\n"
+);
+PyObject *
+variations(PyObject *self, PyObject *args)
+{
+        long long err;
+        const char *m, *v;
+        char result[MAX_SOLUTIONS_SIZE];
+
+        if (!PyArg_ParseTuple(args, "ss", &m, &v))
+                return NULL;
+
+        err = nissy_variations(m, v, MAX_SOLUTIONS_SIZE, result);
+
+        return stringlist_result(err, result);
+}
+
 static PyMethodDef nissy_methods[] = {
         { "inverse", inverse, METH_VARARGS, inverse_doc },
         { "applymoves", applymoves, METH_VARARGS, applymoves_doc },
@@ -392,6 +427,7 @@ static PyMethodDef nissy_methods[] = {
         { "solve", solve, METH_VARARGS, solve_doc },
         { "countmoves", countmoves, METH_VARARGS, countmoves_doc },
         { "comparemoves", comparemoves, METH_VARARGS, comparemoves_doc },
+        { "variations", variations, METH_VARARGS, variations_doc },
         { NULL, NULL, 0, NULL }
 };