RunasSudo/pyRCV2
Archived
1
Fork 0
Code Issues Pull Requests Activity

Update documentation

Browse Source
This commit is contained in:
RunasSudo 2021-01-04 19:35:09 +11:00
parent 0b3651d450
commit a9050e4124
Signed by: RunasSudo
GPG Key ID: 7234E476BF21C61A
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/options.md
View File

@ -71,14 +71,14 @@ When deferred surpluses is enabled, the transfer of all surpluses is deferred if
## Round quota/votes/transfer values/ballot weights to [n] d.p. (--round-quota, --round-votes, --round-tvs, --round-weights) ## Round quota/votes/transfer values/ballot weights to [n] d.p. (--round-quota, --round-votes, --round-tvs, --round-weights)
When rounding is enabled, the specified values are rounded to the specified number of decimal places. This enables, for example, votes to be counted only in integers, while ballot weights and transfer values are calculated to higher precision (according to the *Numbers*) option. When rounding is enabled, the specified values are rounded to the specified number of decimal places. This enables, for example, votes to be counted only in integers, while ballot weights and transfer values are calculated to higher precision (according to the *Numbers* option).
The quota is incremented or rounded up (according to the *Quota* option), whereas votes, transfer values and weights are always rounded down. When enabled, the quota is incremented or rounded up (according to the *Quota* option), whereas votes, transfer values and weights are always rounded down.
In relation to *Round transfer values to [n] d.p.* – note that transfer values are used in STV in calculations of the form *A* × (*B*/*C*), where (*B*/*C*) is the transfer value. The order of operations depends on this setting: In relation to *Round transfer values to [n] d.p.* – note that transfer values are used in STV in calculations of the form *A* × (*B*/*C*), where (*B*/*C*) is the transfer value. The order of operations depends on this setting:
* When this option is disabled (default), (*A* × *B*) is calculated first, then divided by *C*. This minimises rounding errors. * When this option is disabled (default), (*A* × *B*) is calculated first, then divided by *C*. This minimises rounding errors.
* When this option is enabled, (*B*/*C*) is calculated separately first and rounded to the specified precision, before being multiplied by *A*. * When this option is enabled, (*B*/*C*) is calculated separately first and rounded to the specified precision, before being multiplied by *A*. Many STV rules designed for hand counting prescribe this method of manipulating transfer values.
## Surplus order (-s/--surplus-order) ## Surplus order (-s/--surplus-order)
@ -110,7 +110,7 @@ Other surplus transfer methods, such as non-fractional transfers (e.g. random sa
### Exclusion method (--exclusion) ### Exclusion method (--exclusion)
* *Exclude in one round* (default): When excluding candidate(s), transfer all their ballot papers in one stage. * *Exclude in one round* (default): When excluding candidate(s), transfer all their ballot papers in one stage.
* *Exclude by parcel (by order)*: When excluding a candidate, transfer their ballot papers one parcel at a time, in their order each was received. Each parcel forms a separate stage, i.e. if a transfer allows another candidate to meet the quota criterion, no further papers are transferred to that candidate. This option cannot be combined with bulk exclusion. * *Exclude by parcel (by order)*: When excluding a candidate, transfer their ballot papers one parcel at a time, in the order each was received. Each parcel forms a separate stage, i.e. if a transfer allows another candidate to meet the quota criterion, no further papers are transferred to that candidate. This option cannot be combined with bulk exclusion.
* *Exclude by value*: When excluding candidate(s), transfer their ballot papers in descending order of accumulated transfer value. Each transfer of all ballots of a certain transfer value forms a separate stage. * *Exclude by value*: When excluding candidate(s), transfer their ballot papers in descending order of accumulated transfer value. Each transfer of all ballots of a certain transfer value forms a separate stage.
* *Wright method (re-iterate)*: When candidate(s) are excluded, the count is reset from the beginning (minus the excluded candidate(s)). * *Wright method (re-iterate)*: When candidate(s) are excluded, the count is reset from the beginning (minus the excluded candidate(s)).