1
0
This repository has been archived on 2023-11-30. You can view files and clone it, but cannot push or open issues or pull requests.
dtux__serveur-vote-lalis/include/condorcet/Documentation/Election Class/public Election--getResult.md
2022-09-21 14:01:45 +02:00

1.5 KiB

public Election::getResult

Description

public Election->getResult ( [?string $method = null , array $methodOptions = []] ): CondorcetPHP\Condorcet\Result

Get a full ranking from an advanced Condorcet method. Have a look on the supported method, or create your own algorithm.

method: ?string

Not required for use election default method. Set the string name of the algorithm for use of a specific one.

methodOptions: array

Array of option for some methods. Look at each method documentation.

Return value:

(CondorcetPHP\Condorcet\Result) An Condorcet/Result Object (implementing ArrayAccess and Iterator, can be use like an array ordered by rank)

Throws:

  • CondorcetPHP\Condorcet\Throwable\AlgorithmException


Examples and explanation