Skip to content

Commit

Permalink
Update cover.md
Browse files Browse the repository at this point in the history 
``--`` does not play nice and always displays "-" instead of the intended "--"

--page is not a valid subcommand of `cover`

Added a table to better show which options are allowed

t-softdrop does not provide 180 spin capabilities, run the following in sfinder v1.41+:
``java -jar sfinder.jar percent -t v115@9gC8CeH8BeI8BeH8AeD8JeAgH -p TT -K "@nullpomino180" -d t-softdrop
java -jar sfinder.jar percent -t v115@9gC8CeH8BeI8BeH8AeD8JeAgH -p TT -K "@nullpomino180" -d 180``
  • Loading branch information
@Hillosanation
Hillosanation committed Apr 1, 2023
1 parent 468d280 commit a7af4b5
Showing 1 changed file with 68 additions and 36 deletions.
104 changes: 68 additions & 36 deletions content/sfinder/cover.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body{display: flex; justify-content: center;}
.singlePage{width: -webkit-fill-available; max-width: 700px;}
</style>

[[sfinder/|Solution Finder]]'s **Cover** command outputs the probability of setting up/buidling a **specified field** (or multiple), given a specified **pattern**. This output is written in the terminal and the specified **log path**.
[[sfinder/|Solution Finder's]] **Cover** command outputs the probability of setting up/building a **specified field** (or multiple), given a specified **pattern**. This output is written in both the terminal and the specified **log path**.
```YAML {title="Command Structure"}
java -jar sfinder.jar cover --tetfu <fumen> --patterns <pattern>
```
Expand All @@ -23,58 +23,95 @@ 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.
- **Page** (--page, -P): Specify the page of the fumen.
- The default is `1`.
- `--page 2`
**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`.
- The default is `false`.
- `--mirror true`

**Patterns** (--patterns, -p): Determines the queues checked by sfinder. Read more about this parameter [[sfinder/parameter patterns|here]].
- **Hold** (--hold, -H): Specify whether or not a hold slot is usable.
**Patterns** (`--patterns`, `-p`): Determines the queues checked by sfinder. Read more about this parameter [[sfinder/parameter patterns|here]].
- **Hold** (`--hold`, `-H`): Specify whether or not a hold slot is usable.
- By default, it is `use`.
- `--H use` or `--H avoid`
- **Drop** (--drop, -d): Specify what movements are usable.
- **Drop** (`--drop`, `-d`): Specify what movements are usable.
- By default, it uses `softdrop`.
- `--drop harddrop`: only harddrop and kicks.
- `--drop softdrop`: enabled softdrop and kicks.
- `--drop 180`: softdrop but with 180 spins.
- `--drop T-softdrop`: only the T piece is softdropped.
- **Last Softdrop** (--last-softdrop, -ls):

**Mode** (--mode, --M): specifying the condition by which cover will return as successful or failed.
- **Max Clear Line** (--clear-line, -c): Specify the number of line clears cover may use.
<div style="display: flex; flex-direction: column;">
<table>
<tr>
<td><b>Selected option</b></td>
<td><b>Harddrop</b></td>
<td><b>Softdrop</b></td>
<td><b>90 spins</b></td>
<td><b>180 spins</b></td>
</tr>
<tr>
<td>harddrop</td>
<td>✓</td>
<td>✗</td>
<td>✗</td>
<td>✗</td>
</tr>
<tr>
<td>softdrop</td>
<td>✓</td>
<td>✓</td>
<td>✓</td>
<td>✗</td>
</tr>
<tr>
<td>180</td>
<td>✓</td>
<td>✓</td>
<td>✓</td>
<td>✓</td>
</tr>
<tr>
<td>t-softdrop</td>
<td>✓</td>
<td>T only</td>
<td>T only</td>
<td>✗</td>
</tr>
</table>
</div>

<!-- TODO: note there are also the many t-spin specific drop modes that are not listed. -->
<!-- TODO: note the availability of the 180 option in sfinder v1.40 is configurable, since kick tables are customizable since then. -->

- **Last Softdrop** (`--last-softdrop`, `-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.
- **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.
- **Max Softdrop** (--max-softdrop, -ms): Specify how many times pieces can be softdropped in order to build a setup.
- **Max Softdrop** (`--max-softdrop`, `-ms`): Specify how many times pieces can be softdropped in order to build a setup.
- This setting is only enabled in conjunction with `--mode`
- By default, it uses `-1`, no limit placed on softdrops.
- ``--max-softdrop 2
- `--max-softdrop 2`

**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``
**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`
___
## 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`.
**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** (`--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.
___
## Miscellaneous Parameters
**Log path** (--log-path, -lp): create a .txt file output from the output of the command.
**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`

**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.
**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.
**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`

Expand All @@ -95,11 +132,6 @@ ___
<td>-t</td>
<td>null</td>
</tr>
<tr>
<td>--page</td>
<td>-P</td>
<td>1</td>
</tr>
<tr>
<td>--patterns</td>
<td>-p</td>
Expand Down Expand Up @@ -210,14 +242,14 @@ OR = 61.67 % [3108/5040]
AND = 16.11 % [812/5040]
```

Each item under `success` represents one fumen entered under the ``--tetfu`` parameter, in order. It contains the following:
Each item under `success` represents one fumen entered under the `--tetfu` parameter, in order. It contains the following:
- `33.33 %`: The percentage cover of the fumen.
- `[1680/5040]`: The number of successful over total patterns of the fumen.
- `http://fumen.zui.jp/?v115@vhFRQJUGJKJJvMJTNJGBJ`: A link to the fumen.

Furthermore, it tallies up the results as:
- `OR`: the cover if at least one of the fumens can be built.
- `AND`: the cover if all of the fumens needs to be built.
- `OR`: the amount of queues that can build at least one of the fumens.
- `AND`: the amount of queues that can build all of the fumens.
___
An **example CSV output** of the cover command.
<center>
Expand Down Expand Up @@ -253,9 +285,9 @@ An **example CSV output** of the cover command.
</table>
</center>

The CSV output lists the first column for the patterns used, and extra colums are allocated for every fumen in order.
The CSV output lists the first column for the patterns used, and extra columns are allocated for every fumen in order.
- `X`: the fumen is not buildable for the equivalent pattern.
- `O`: the fumen is buildable for the equivalent pattern.
___
## Special Uses
1. Cover's output can be converted into an [[sfinder/sfinder path|sfinder path output]] to be used to find [[sfinder/custom minimals|custom minimals]], such as Quad PC minimals or T-Spin minimals.
1. Cover's output can be converted into an [[sfinder/path|sfinder path output]] to be used to find [[sfinder/custom minimals|custom minimals]], such as Quad PC minimals or T-Spin minimals.

0 comments on commit a7af4b5

Please sign in to comment.