Condorcet\Algo\Pairwise

Complexity

Total Complexity

35

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

97.37%

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__clone()	0	4	1
A	setElection()	0	4	1
A	offsetSet()	0	1	1
A	offsetExists()	0	3	1
A	offsetUnset()	0	1	1
A	offsetGet()	0	3	1
A	rewind()	0	4	1
A	current()	0	3	1
A	key()	0	3	1
A	next()	0	5	2
A	valid()	0	3	1
A	__construct()	0	6	1
A	addNewVote()	0	6	1
A	removeVotes()	0	16	4
A	getExplicitPairwise()	0	20	4
A	formatNewpairwise()	0	20	4
A	doPairwise()	0	11	2

<?php
/*
    Condorcet PHP - Election manager and results calculator.
    Designed for the Condorcet method. Integrating a large number of algorithms extending Condorcet. Expandable for all types of voting systems.

    By Julien Boudry and contributors - MIT LICENSE (Please read LICENSE.txt)
    https://github.com/julien-boudry/Condorcet
*/
declare(strict_types=1);

namespace CondorcetPHP\Condorcet\Algo;

use CondorcetPHP\Condorcet\{CondorcetVersion, Election, Vote};
use CondorcetPHP\Condorcet\Timer\Chrono as Timer_Chrono;

class Pairwise implements \ArrayAccess, \Iterator
{
    use CondorcetVersion;

    // Implement ArrayAccess
    public function offsetSet($offset, $value) : void {}

    public function offsetExists($offset) : bool {
        return isset($this->_Pairwise[$offset]);
    }

    public function offsetUnset($offset) : void {}

    public function offsetGet($offset) : ?array {
        return $this->_Pairwise[$offset] ?? null;
    }


    // Implement Iterator
    private $valid = true;

    public function rewind() : void {
        reset($this->_Pairwise);
        $this->valid = true;
    }

    public function current() : array {
        return $this->_Pairwise[$this->key()];
    }

    public function key() : ?int {
        return key($this->_Pairwise);
    }

    public function next() : void {
        if (next($this->_Pairwise) === false) :
            $this->valid = false;
        endif;
    }

    public function valid() : bool {
        return $this->valid;
    }   


    // Pairwise

    protected $_Election;
    protected $_Pairwise_Model;
    protected $_Pairwise;

    public function __construct (Election $link)
    {
        $this->setElection($link);
        $this->formatNewpairwise();
        $this->doPairwise();
    }

    public function __clone ()
    {
        $this->_Election = null;
    }

    public function setElection (Election $election) : void
    {
        $this->_Election = $election;
    }

    public function addNewVote (int $key) : void
    {
        new Timer_Chrono ( $this->_Election->getTimerManager(), 'Add Vote To Pairwise' );

        $this->computeOneVote($this->_Pairwise,$this->_Election->getVotesManager()[$key]);
    }

    public function removeVotes (int $key) : void
    {
        new Timer_Chrono ( $this->_Election->getTimerManager(), 'Remove Vote To Pairwise' );

        $diff = $this->_Pairwise_Model;

        $this->computeOneVote($diff,$this->_Election->getVotesManager()[$key]);

        foreach ($diff as $candidate_key => $candidate_details) :
            foreach ($candidate_details as $type => $opponent) :
                foreach ($opponent as $opponent_key => $score) :
                    $this->_Pairwise[$candidate_key][$type][$opponent_key] -= $score;
                endforeach;
            endforeach;
        endforeach;
    }

    public function getExplicitPairwise () : array
    {
        $explicit_pairwise = [];

        foreach ($this->_Pairwise as $candidate_key => $candidate_value) :

            $candidate_name = $this->_Election->getCandidateObjectFromKey($candidate_key)->getName();

            foreach ($candidate_value as $mode => $mode_value) :

                foreach ($mode_value as $candidate_list_key => $candidate_list_value) :
                    $explicit_pairwise[$candidate_name][$mode][$this->_Election->getCandidateObjectFromKey($candidate_list_key)->getName()] = $candidate_list_value;
                endforeach;

            endforeach;

        endforeach;

        return $explicit_pairwise;
    }

    protected function formatNewpairwise () : void
    {
        $this->_Pairwise_Model = [];

        foreach ( $this->_Election->getCandidatesList() as $candidate_key => $candidate_id ) :

            $this->_Pairwise_Model[$candidate_key] = [ 'win' => [], 'null' => [], 'lose' => [] ];

            foreach ( $this->_Election->getCandidatesList() as $candidate_key_r => $candidate_id_r ) :

                if ($candidate_key_r !== $candidate_key) :
                    $this->_Pairwise_Model[$candidate_key]['win'][$candidate_key_r]   = 0;
                    $this->_Pairwise_Model[$candidate_key]['null'][$candidate_key_r]  = 0;
                    $this->_Pairwise_Model[$candidate_key]['lose'][$candidate_key_r]  = 0;
                endif;

            endforeach;

        endforeach;
    }

    protected function doPairwise () : void
    {
        // Chrono
        new Timer_Chrono ( $this->_Election->getTimerManager(), 'Do Pairwise' );

        $this->_Pairwise = $this->_Pairwise_Model;

        foreach ( $this->_Election->getVotesManager()->getVotesValidUnderConstraintGenerator() as $vote_id => $oneVote ) :
            $this->computeOneVote($this->_Pairwise, $oneVote);
        endforeach;
    }

    protected function computeOneVote (array &$pairwise, Vote $oneVote) : void
    {
        $vote_ranking = $oneVote->getContextualRanking($this->_Election);

        $voteWeight = $this->_Election->isVoteWeightAllowed() ? $oneVote->getWeight() : 1;

        $vote_candidate_list = [];

        foreach ($vote_ranking as $rank) :
            foreach ($rank as $oneCandidate) :
                $vote_candidate_list[] = $oneCandidate;
            endforeach;
        endforeach;

        $done_Candidates = [];

        foreach ($vote_ranking as $candidates_in_rank) :

            $candidates_in_rank_keys = [];

            foreach ($candidates_in_rank as $candidate) :
                $candidates_in_rank_keys[] = $this->_Election->getCandidateKey($candidate);
            endforeach;

            foreach ($candidates_in_rank as $candidate) :

                $candidate_key = $this->_Election->getCandidateKey($candidate);

                // Process
                foreach ( $vote_candidate_list as $g_Candidate ) :

                    $g_candidate_key = $this->_Election->getCandidateKey($g_Candidate);

                    if ($candidate_key === $g_candidate_key) :
                        continue;
                    endif;

                    // Win & Lose
                    if (    !in_array($g_candidate_key, $done_Candidates, true) && 
                            !in_array($g_candidate_key, $candidates_in_rank_keys, true) ) :

                        $pairwise[$candidate_key]['win'][$g_candidate_key] += $voteWeight;
                        $pairwise[$g_candidate_key]['lose'][$candidate_key] += $voteWeight;

                        $done_Candidates[] = $candidate_key;

                    // Null
                    elseif (in_array($g_candidate_key, $candidates_in_rank_keys, true)) :
                        $pairwise[$candidate_key]['null'][$g_candidate_key] += $voteWeight;
                    endif;

                endforeach;

            endforeach;

        endforeach;
    }

}