aboutsummaryrefslogtreecommitdiff
path: root/TODO.md
blob: 2ef405df2af383767d255e574b929ec2c469dfcb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# TODO list

This is a list of things that I would like to add or change at some point.
It's more of a personal reminder than anything else.

## Version 2.0.2
### Website
* now gen takes 40 minutes
### Changelog
* Only improved table generation speed, but this required huge changes in
  coordinates.c and symcoord.c (+ some minor changes in other parts).

## For version 2.1
### Coordinates
* Text (README.md) description of coordinate system with 3 (or 4) types of
  coordinates: basic (+ fundamental), sym, composite (consisting of at most
  one sym + one or more basic)
* Use this to restructure the coordinate part; maybe fundamental coordinates
  do not need to exist???
* Add also "transform" for every coordinate. For example, for EO and similar
  only allow transformations that fix the EO axis.
* Also: "basic" symcoord do not allow trans, composite coordinates assume
  the transformation fixes the basic sumcoord
* For each coordinate, manually disallow "bad" moves, or just ignore the error
  (probably better to check: low performance cost, detect problems that I might
  be overlooking)
### Changes to Step and Solve
* Revolutionize: do everything based on coordinates, replace Cube with
  CubeArray (or just 4 values, so consistency check is super easy);
  remove tables for fast inverse.
* No need for most of step data: just solve a list of coordinates
  (+ associated pruning tables)
* For steps that accept multiple solved states (e.g. drany):
  just find a way to "merge" multiple steps as alternatives; or
  offer multiple lists of coordinates as alternatives
* De Bondt's trick: list of 3 coords (as indexes in coord array of the step)
  that if evaluated to the same pruning value allow for de bondt's trick.
* NISS: compute inverse based on current use moves just before switching,
  using CubeArray; it is not too slow.
### Loading at startup vs dynamically
* Consider moving more things to the initial loading phase (i.e. remove
  many of the "initialized" parts)
### Documentation
* Write an examples.md file
* More screenshots!
### Tables management
* Check files in tables directory, add command to remove old / extraneous files
* Add checksum to check that tables are generated / downloaded correctly
* Edit download page update instructions to tell what to do when changing tables

## Commands

### Commands that are available in nissy 1.0, but not in this version (yet):
* drcorners (solve corners after dr)
* search and improve non-optimal subsequences
* save and edit algs as "variables"
  (or just use a "logging system" to keep info about previously run commands,
including e.g. solutions that were not shown because -c)

### More steps for `solve`
* QTM optimal solving
* 5-side solve (for robots)
* Block-building steps (cross, roux blocks, ...)
* Other common steps (LSE, ...)

### Improvements to currently implemented commands
* solve should re-orient first if needed and not just give up if centers are off
* solve should try up to a small bound without loading the large pruning table
* silent batch mode without >>>

### New features
* configurability: add an `alias` command, run config file at startup
* configure max ram to be used (via config file and/or command line option)
* transform alg, rufify etc...
* command notation to list available moves
* make multi-step solve much more general and create command
* input directly cube status instead of moves
  (graphical: maybe there is a cubing.js function; command line: ???)

## Distribution
* webapp (cgi)

## Technical stuff

### Testing
* write some proper tests, move test_coord to the testing module(s)

### Memory management
* free pruning table after solve is done? if I do this I need to deafault to a
  small table for < 8 moves solutions or smth
* improve multi-threading when solving multiple scrambles
* nissy -M maxmem option for running with at most maxmem memory; if exceeded
  when loading a pruning table, return failure (or make every solve command
  use tiny tables instead?); if maxmem is very 600Mb or
  less do not use invtables (the performance loss is minimal anyway). If the
  limit is really tiny, do not use mtables or ttables (but this would be
  very slow and probably nobody will ever use it)
* Check if memory is enough for loading pruning tables; if not, abort
* For optimal solver: choose largest that fits in memory between nxopt and light

### Structural changes
* client/server architecture: run a server process in the background so that
  multiple client processess can send it queries and get results; this would
  open up the door for a web-based version or graphical clients

### Cleanup
* sort again functions alphabetically in their files
* more stuff to load at start (or when suitable command is called) rather
  than when called directly, to avoid nasty problems with threading
* parse command args: one function per arg type, then each command has
  a list of options that it accepts (as a string)

Generated with cgit - Back to sebastiano.tronto.net