Solution Finder: Spin
Work In Progress
This page is currently being worked on! For the meantime, assume that none of the information presented here is correct.
Solution Finder’s Spin command outputs all the ways to get a specified spin (TS0, TSS, TSD, and Mini Variants) from a specified field, given a specified pattern. The terminal output is written into a file in the specified log path, and a file containing the path data is generated in the specified output base.
|
|
|
|
Input Parameters
Specified Field (--tetfu
, -t
): the fumen code that sfinder begins working with. If not specified, the file field.txt
in the input
folder is used.
- Page (
--page
,-P
): Specify the page of the fumen.- The default is
1
(the first page) --page 2
- The default is
- Clear Line (
--clear-line
,-c
): Specify the number of line clears for a perfect clear.- The default is
4
--clear-line 6
- The default is
Patterns (--patterns
, -p
): Determines the queues checked by sfinder. Read more about this parameter here.
Output Parameters
Format (--format
, -f
): Dictates the way the path output is written onto a file.
- By default, the output is in
html
. - With
--format html
(the default), there are two outputs (if--max-layer
is not specified):path_unique.html
contains a list of all the possible solves found by sfinder.path_minimal.html
contains a loosely defined set of minimals. Read more about what these mean over at this page.
--format csv
will output the path results as a csv. You will need to specify further what kind of info will be displayed in the csv, or you will end up with nonsensical text. Some more info about different csv outputs here.
Max Layer (--max-layer
, -L
): refers to the outputs of path when using the html format.
- By default, it is set to 2
(outputs both path_unique.html
and path_minimal.html
)
- The only other option is -L 1
, where it only outputs path_unique.html
.
Key (--key
, -k
): refers to the way the path result is sorted when using the csv format.
- By default, it is set to none
.
- --key solution
outputs the path info grouped by solution.
- --key pattern
outputs the path info grouped by queue.
- --key use
outputs the path info grouped by pieces used
- The parameters may also be shortened to just the first name (--key use
= -k u
).
Split (--split
, -s
): refers to the way the solution fumen is built.
- By default, it is set to no
(output is a normal fumen).
- --split yes
builds the solves piece-by-piece (glued fumen).
Miscellaneous Parameters
Output Base (--output-base
, -o
): Specify the path data file output.
- By default, the path data is written into
output/path.csv
,path_minimal.html
, orpath_unique.html
(depending on your path command). --output-base output/tubpath.csv
Log path (--log-path
, -lp
): Specify the .txt file output from the output of the command.
- By default, the log path is
output/last_output.txt
. --log-path output/foundpaths.txt
Specified Field from a file (--field-path
, -fp
): instead of defining the fumen code using --tetfu
, you can specify a .txt file that contains a fumen code instead.
- By default, the field path is
input/field.txt
. --field-path input/sdpc.txt
Patterns from a file (--patterns-path
, -pp
): instead of defining patterns using --patterns
, you can specify a .txt file that contains either the actual queues, or patterns.
- By default, the patterns path is
input/patterns.txt
. --patterns-path input/filteredqueue.txt
Cached Bit (--cached-bit
, -cb
): Specify the smallest bit of the cache to use for the internal algorithm. You most likely will never need to use this parameter.
Summary
Input Parameters | ||
---|---|---|
Parameter | Shorthand | Default |
--tetfu | -t | null |
--page | -P | 1 |
--clear-line | -c | 4 |
--patterns | -p | null |
Output Parameters | ||
---|---|---|
--format | -f | html |
--max-layer | -L | 2 |
--key | -k | none |
--split | -s | no |
Miscellaneous Parameters | ||
---|---|---|
--output-base | -o | output/path.txt |
--log-path | -lp | output/last_output.txt |
--field-path | -fp | input/field.txt |
--patterns-path | -pp | input/patterns.txt |
--cached-bit | -cb | 0 |
Example Commands and Outputs
An example output of the path command:
|
|
These are the outputs produced by various :
- With
--format html
(the default), the output looks like this for bothpath_minimal.html
andpath_unique.html
:
|
|
No line erasure vs with line erasure:
- With
--format csv --key solution
, the output file (output/path.csv
) contains rows that have the path info sorted by solution:
|
|
- With
--format csv --key pattern
, the output file (output/path.csv
) contains rows that have the path info sorted by queue:
|
|
- With
--format csv --key use
, the output file (output/path.csv
) contains rows that have the path info sorted by pieces used:
|
|