Skip to content

Commit

Permalink
amend parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
@Hillosanation
Hillosanation committed Apr 2, 2023
1 parent 9161ec4 commit 2968e46
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 27 deletions.
31 changes: 24 additions & 7 deletions content/sfinder/cover.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ java -jar sfinder.jar cover -t <fumen> <fumen> -p <pattern>
___
## Input Parameters
**Specified Field(s)** (`--tetfu`, `-t`): the [[sfinder/fumen editor#Fumen Code|fumen code(s)]] that sfinder begins working with. If not specified, the file `field.txt` in the `input` folder is used. Input multiple fumens for fields by separating the fumens with spaces.
- **Mirror** (--mirror, -m): Whether or not to include the mirrors for all inputted fumens. The outputs will mark mirrored `fumen` inputs as `fumen#mirror`.
- **Mirror** (`--mirror`, `-m`): Whether or not to include the mirrors for all inputted fumens. The outputs will mark mirrored `fumen` inputs as `fumen#mirror`.
- The default is `false`.
- `--mirror true`

Expand All @@ -37,9 +37,12 @@ ___

{{< sfinder-parameters/drop t-spin-table="true" >}}

- **Last Softdrop** (`--last-softdrop`, `-l`): Allows the last nth pieces to use softdrop regardless of the value of `--drop`.
- **Last Softdrop** (`--last-sd`, `-l`): Allows the last nth pieces to use softdrop regardless of the value of `--drop`.

**Mode** (`--mode`, `--M`): specifying the condition by which cover will return as successful or failed.
> [!WARNING] WIP
>
> This section can be improved by showcasing the possible modes.
- **Max Clear Line** (`--clear-line`, `-c`): Specify the number of line clears cover may use.
- By default, it is `-1`, meaning there is no limit.
- `--max-clearline 1` for a 4-line high perfect clear field may allow you to get that field's quad clear chance.
Expand All @@ -51,17 +54,26 @@ ___
**Starting B2B** (`--starting-b2b`, `-sb`): specifying the number of B2B clears is required for a successful output.
- By default, it uses `0`, meaning no B2B is required.
- `--starting-b2b 2`

**Kick table** (`--kicks`, `-K`):
> [!WARNING] WIP
>
> This section isn't filled out yet.
___
## Output Parameters
**Priority** (`--priority`, `-P`): Only one setup can be marked as `O` for all the fumens provided. This will be the first setup that is buildable in the order of the fumens given in `--tetfu`.
- By default, priority is `True`.
- `--priority True`

**Fail Count** (`--fail-count`, `-fc`): determines the number of fail queues displayed at the end of the output.
- By default, fail count is `100`.
- `--fail-count -1` displays as many fail queues as possible.
**Failed Count** (`--failed-count`, `-fc`): determines the number of failed queues displayed at the end of the output.
- By default, failed count is `100`.
- `--failed-count -1` displays as many failed queues as possible.
___
## 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, or path_unique.html` (depending on your path command).
- `--output-base output/tubpath.csv`

**Log path** (`--log-path`, `-lp`): create a .txt file output from the output of the command.
- By default, the log path is `output/last_output.txt`.
- `--log-path output/chances.txt`
Expand Down Expand Up @@ -117,7 +129,7 @@ ___
<td>-1</td>
</tr>
<tr>
<td>--last-softdrop</td>
<td>--last-sd</td>
<td>-l</td>
<td>0</td>
</tr>
Expand All @@ -126,6 +138,11 @@ ___
<td>-m</td>
<td>false</td>
</tr>
<tr>
<td>--kicks</td>
<td>-K</td>
<td>srs</td>
</tr>
</table>
<br>
<table>
Expand All @@ -148,7 +165,7 @@ ___
<td>normal</td>
<tr>
<td>--output-base</td>
<td>-ob</td>
<td>-o</td>
<td>output/cover.csv</td>
</tr>
</table>
Expand Down
45 changes: 38 additions & 7 deletions content/sfinder/path.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,22 @@ ___
- **Drop** (`--drop`, `-d`): Specify what movements sfinder uses to try and find solutions.

{{< sfinder-parameters/drop t-spin-table="true" >}}

**Specified only** (`--specified-only`, `-so`):
>[!WARNING] WIP
>
> This section isn't filled out yet.
**Reserved minos** (`--reserved`, `-r`):
>[!WARNING] WIP
>
> This section isn't filled out yet.
**Kick table** (`--kicks`, `-K`):
> [!WARNING] WIP
>
> This section isn't filled out yet.
___
## Output Parameters
**Format** (`--format`, `-f`): Dictates the way the path output is written onto a file.
Expand All @@ -45,15 +61,15 @@ ___
- `--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, <u>or you will end up with nonsensical text</u>. Some more info about different csv outputs [[#Example Commands and 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`.
- 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 <u>grouped by solution</u>.
- `--key pattern` outputs the path info <u>grouped by queue</u>.
- `--key use` outputs the path info <u>grouped by pieces used</u>
- The parameters may also be shortened to just the first name (`--key use` = `-k u`).
- By default, it is set to `none`.
- `--key solution` outputs the path info <u>grouped by solution</u>.
- `--key pattern` outputs the path info <u>grouped by queue</u>.
- `--key use` outputs the path info <u>grouped by pieces used</u>
- 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).
Expand Down Expand Up @@ -123,6 +139,21 @@ ___
<td style="text-align: center;">-d</td>
<td>softdrop</td>
</tr>
<tr>
<td>--kicks</td>
<td style="text-align: center;">-K</td>
<td>srs</td>
</tr>
<tr>
<td>--specified-only</td>
<td style="text-align: center;">-so</td>
<td>yes</td>
</tr>
<tr>
<td>--reserved</td>
<td style="text-align: center;">-r</td>
<td>false</td>
</tr>
</table>
<br>
<table>
Expand Down
18 changes: 14 additions & 4 deletions content/sfinder/percent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,20 @@ ___
- **Drop** (`--drop`, `-d`): Specify what movements are usable. By default, it uses `softdrop`.

{{< sfinder-parameters/drop t-spin-table="false" >}}

**Kick table** (`--kicks`, `-K`):
> [!WARNING] WIP
>
> This section isn't filled out yet.
___
## Output Parameters
**Tree Depth** (`--tree-depth`, `-td`): determines the depth of the tree diagram of the output. The tree output checks for the sol% of the field if the first few pieces of the queue is known.
- By default, tree depth is 3.
- `--tree-depth 1`

**Fail Count** (`--fail-count`, `-fc`): determines the number of fail queues displayed at the end of the output.
- By default, fail count is 100.
- `--fail-count -1` displays as many fail queues as possible.
**Failed Count** (`--failed-count`, `-fc`): determines the number of failed queues displayed at the end of the output.
- By default, failed count is 100.
- `--failed-count -1` displays as many failed queues as possible.
___
## Miscellaneous Parameters
**Log path** (`--log-path`, `-lp`): create a .txt file output from the output of the command.
Expand Down Expand Up @@ -100,6 +105,11 @@ ___
<td style="text-align: center;">-d</td>
<td>softdrop</td>
</tr>
<tr>
<td>--kicks</td>
<td style="text-align: center;">-K</td>
<td>srs</td>
</tr>
</table>
<br>
<table>
Expand Down Expand Up @@ -203,7 +213,7 @@ Success pattern tree [Head 1 pieces]:
? Z -> 52.50 %
? O -> 47.50 %

# Fail Count (--fail-count, -fc)
# Failed Count (--failed-count, -fc)
-------------------
Fail pattern (max. 5)
[J, L, T, O]
Expand Down
9 changes: 0 additions & 9 deletions content/sfinder/spin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,6 @@ ___
- By default, the patterns path is `input/patterns.txt`.
- `--patterns-path input/filteredqueue.txt`

**Threads** (`--threads`, `-th`): Specify the number of threads to use when sfinder is running. Basically, threads are tiny virtual CPUs used to calculate stuff. <u>Almost no need to ever touch this.</u>
- By default, the number of threads used is 1.
- `--threads 0` will allow sfinder to use as many threads as is present in the execution environment.

**Cached Bit** (`--cached-bit`, `-cb`): Specify the smallest bit of the cache to use for the internal algorithm. <u>You most likely will never need to use this parameter</u>.
___
## Summary
Expand Down Expand Up @@ -167,11 +163,6 @@ ___
<td style="text-align: center;">-pp</td>
<td>input/patterns.txt</td>
</tr>
<tr>
<td>--threads</td>
<td style="text-align: center;">-th</td>
<td>-1</td>
</tr>
<tr>
<td>--cached-bit</td>
<td style="text-align: center;">-cb</td>
Expand Down

0 comments on commit 2968e46

Please sign in to comment.