File Coverage

blib/lib/Vote/Count/Score.pm

Criterion	Covered	Total	%
statement	48	48	100.0
branch	8	8	100.0
condition	4	4	100.0
subroutine	9	9	100.0
pod	2	2	100.0
total	71	71	100.0

use strict;
use warnings;
use 5.024;
use feature qw /postderef signatures/;

package Vote::Count::Score;

use Moose::Role;

# use Storable 3.15 qw(dclone);
# use Try::Tiny;

our $VERSION='2.00';

=head1 NAME

Vote::Count::Score

=head1 VERSION 2.00

=cut

# ABSTRACT: Provides Score Method for Range Ballots to Vote::Count objects

no warnings 'experimental';
use Vote::Count::RankCount;
# use Try::Tiny;
# use boolean;

=pod

=head1 Synopsis

  my $RangeElection = Vote::Count->new(
    BallotSet  => read_range_ballots('t/data/tennessee.range.json')
    );
  my $scored = $RangeElection->Score();

=head1 Range Score Methods

When Range (Cardinal) Ballots are used, it is simple and obvious to total the scores provided by the voters. This contrasts to the related Borda Method which assigns scores based on position on a Ranked Ballot.

=head2 Score

Returns a RankCount Object with the choices scored using the scores set by the voters, for Range Ballots.

=cut

sub Score ( $self, $active = undef ) {
  my $depth = $self->BallotSet()->{'depth'};
  # my @Ballots = $self->BallotSet()->{'ballots'}->@*;
  $active = $self->Active() unless defined $active;
  my %scores = ( map { $_ => 0 } keys( $active->%* ) );
  for my $ballot ( $self->BallotSet()->{'ballots'}->@* ) {
    for my $choice ( keys %scores ) {
      if ( defined $ballot->{'votes'}{$choice} ) {
        $scores{$choice} += $ballot->{'count'} * $ballot->{'votes'}{$choice};
      }
    }
  }
  return Vote::Count::RankCount->Rank( \%scores );
}

=head2 RangeBallotPair

Used for pairings against Range Ballots. Used by Condorcet and STAR.

  where $I is a Vote::Count object created with a Range Ballot Set.

  my ( $countA, $countB ) = $I->RangeBallotPair( $A, $B) ;

=cut

sub RangeBallotPair ( $self, $A, $B ) {
  my $countA   = 0;
  my $countB   = 0;
  my $approval = $self->Approval();
  for my $ballot ( $self->BallotSet()->{'ballots'}->@* ) {
    my $prefA = $ballot->{'votes'}{$A} || 0;
    my $prefB = $ballot->{'votes'}{$B} || 0;
    if    ( $prefA > $prefB ) { $countA += $ballot->{'count'} }
    elsif ( $prefA < $prefB ) { $countB += $ballot->{'count'} }
    else                      { }
  }
  return ( $countA, $countB );
}

1;

#FOOTER

=pod

BUG TRACKER

L<https://github.com/brainbuz/Vote-Count/issues>

AUTHOR

John Karr (BRAINBUZ) [e-mail]

CONTRIBUTORS

Copyright 2019-2021 by John Karr (BRAINBUZ) [e-mail].

LICENSE

This module is released under the GNU Public License Version 3. See license file for details. For more information on this license visit L<http://fsf.org>.

SUPPORT

This software is provided as is, per the terms of the GNU Public License. Professional support and customisation services are available from the author.

=cut