Options and parameters are passed to the toolkit functions by way of a specialized data structure. The members of this data structure are described below. Items that are deprecated are in pink. Deprecated items will no longer be used in version 2.0 of the toolkit.
Name | Description | Options | Method(s) |
possible_words | Strategy for computing the number of possible words | x | Use the positive integer value x, or Inf | entropy_bub entropy_nsb entropy_tpmc entropy_ww |
"recommended" | Use the independently recommended value for each method |
"unique" | Use number of unique observed words—corresponds to *_possible_words_strategy=0 |
"total" | Use total number of observed words (direct methods only)—corresponds conceptually to *_possible_words_strategy=1 |
"possible" | Use maximum number of possible words based on observed letters (direct methods only) |
"min_tot_pos" | Use minimum of "total" or "possible_obs" (direct methods only)—corresponds to *_possible_words_strategy=2 for tpmc and ww |
"min_lim_tot_pos" | Use minimum of 105, "total", or "possible_obs" (direct methods only)—corresponds to *_possible_words_strategy=2 for bub |
tpmc_possible_words_strategy | Strategy for computing the number of possible words | 0 | Use number of unique observed words | entropy_tpmc |
1 | Use total number of observed words |
2 | Use maximum number of possible words |
bub_possible_words_strategy | Strategy for computing the number of possible words | 0 | Use number of unique observed words | entropy_bub |
1 | Use total number of observed words |
2 | Use maximum number of possible words |
bub_compat | BUB compatibility parameter | 0 | Compatible with paper | entropy_bub |
1 | Compatible with posted code |
ww_possible_words_strategy | Strategy for computing the number of possible words | 0 | Use number of unique observed words | entropy_ww |
1 | Use total number of observed words |
2 | Use maximum number of possible words |