org.bolson.vote
Class STV

java.lang.Object
  extended by org.bolson.vote.VotingSystem
      extended by org.bolson.vote.RankedVotingSystem
          extended by org.bolson.vote.STV
All Implemented Interfaces:
java.io.Serializable

public class STV
extends RankedVotingSystem

Single Transferrable Vote, IRV for multi-seat elections.

See Also:
Wikipedia: Single Transferrable Vote, Serialized Form

Nested Class Summary
protected static class STV.Ballot
           
 
Field Summary
 
Fields inherited from class org.bolson.vote.VotingSystem
debug, NO_VOTE, numc
 
Constructor Summary
STV(int numCandidates)
          In addition to interfaced methods, there shall be a constructor taking the integer number N of choices to be voted on.
 
Method Summary
 int[] getWinners()
          Do processing if necessary, return winners.
 int[] getWinners(int numSeats)
          Do processing if necessary, return winners.
 java.lang.String htmlSummary(java.lang.String[] names)
          A fancy html representation.
 VotingSystem init(java.lang.String[] argv)
          Arguments to modify behavior of STV
protected  void intoBucket(STV.Ballot b)
           
protected  void intoBucket(java.util.Vector bv)
           
protected  void intoBucket(java.util.Vector bv, double weightmod)
           
protected  void myInit()
           
 java.lang.String name()
          Return name of this voting system.
static double quota(int style, double votes, int seats)
           
 void recountBuckets()
           
 void resetBuckets()
           
 java.lang.String toString(java.lang.String[] names)
          A more interesting representation.
 int voteRanking(int[] ranking)
           
 
Methods inherited from class org.bolson.vote.RankedVotingSystem
voteRating, voteRating, voteRating
 
Methods inherited from class org.bolson.vote.VotingSystem
checkRatedVote, getDebugHTML, getDebugText, getNumberOfCandidates, getWinners, getWinners, isValidRankedVote, isValidRatedVote, normalize, normalize, normalize, normalize, normalize, normalizeL2, normalizeL2, normalizeL2, normalizeL2, normalizeL2, stretch, voteRating
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

STV

public STV(int numCandidates)
In addition to interfaced methods, there shall be a constructor taking the integer number N of choices to be voted on.

Method Detail

quota

public static double quota(int style,
                           double votes,
                           int seats)

myInit

protected void myInit()

init

public VotingSystem init(java.lang.String[] argv)
Arguments to modify behavior of STV

Overrides:
init in class VotingSystem
Returns:
this so that you can do
vs = (new VS(numc)).init( new String[]{"blah", "grunt"} );

intoBucket

protected void intoBucket(STV.Ballot b)

intoBucket

protected void intoBucket(java.util.Vector bv)

intoBucket

protected void intoBucket(java.util.Vector bv,
                          double weightmod)

resetBuckets

public void resetBuckets()

recountBuckets

public void recountBuckets()

voteRanking

public int voteRanking(int[] ranking)
Specified by:
voteRanking in class VotingSystem
Parameters:
ranking - An array int[N]. ranking[i] is the ranking of choice i. rankings are 1 (most preferred) through N (least). INT_MAX, N, or NO_VOTE for unspecified.
Returns:
0 on success

getWinners

public int[] getWinners()
Do processing if necessary, return winners. It might be a good idea to implement getWinners(java.io.PrintWriter) and implement this to call it with null.

Specified by:
getWinners in class VotingSystem
Returns:
indecies of winners (hopefully 1 of them)

getWinners

public int[] getWinners(int numSeats)
Do processing if necessary, return winners. Default implementation returns null so that not all systems have to be multi-seat systems.

Overrides:
getWinners in class VotingSystem
Parameters:
numSeats - the number of seats available.
Returns:
indecies of winners, hopefully numSeats of them but in case of ties there may be more and in case of some internal schism there may be fewer. Check .length to be sure.

toString

public java.lang.String toString(java.lang.String[] names)
A more interesting representation. Include the names of the choices voted upon in the representation.

Specified by:
toString in class VotingSystem
Parameters:
names - The names of the choices.
Returns:
state, with names!

htmlSummary

public java.lang.String htmlSummary(java.lang.String[] names)
A fancy html representation. Include the names of the choices voted upon in the representation.

Specified by:
htmlSummary in class VotingSystem
Parameters:
names - The names of the choices. May be null.
Returns:
state, with names!

name

public java.lang.String name()
Description copied from class: VotingSystem
Return name of this voting system. This is a function so that it can potentially construct a detailed name based on options set in init().

Overrides:
name in class VotingSystem
Returns:
a descriptive name