meekstv

README

meekstv

An implementation of single transferable vote by Meek's Method.

References:

• Algorithm 123 - Single Transferable Vote by Meek's Method

• Voting matters, Issue 22 - Implementing STV by Meek’s method

Documentation

Index

• Variables
• type Ballot
• type Ballots
  • func (b Ballots) TotalCount() int
• type Candidate
• type CandidateState
  • func (c CandidateState) Has(s CandidateState) bool
  • func (c CandidateState) HasAny(s CandidateState) bool
• type Config
• type Detail
  • func (d Detail) WriteReport(wr io.Writer) error
• type Result
  • func Count(config Config) (Result, error)
• type Round
  • func (round Round) Describe() string
  • func (round Round) Events() []event.Event
• type WichmannHillRandom
  • func NewWichmannHillRandom(s1, s2, s3 int) WichmannHillRandom

Variables

var (
	Precision     = 8
	MaxIterations = 1000
)

Types

type Ballot

type Ballot struct {
	Count       int
	Preferences []int
}

type Ballots

type Ballots []Ballot

func (Ballots) TotalCount

func (b Ballots) TotalCount() int

type Candidate

type Candidate struct {
	ID     int
	Name   string
	Weight int64
	Votes  int64
	State  CandidateState
	Rank   int
	// contains filtered or unexported fields
}

type CandidateState

type CandidateState uint8

const (
	Hopeful CandidateState = 1 << iota
	Elected
	Excluded
	Lowest
	Random
	Hopeless
	Withdrawn
)

func (CandidateState) Has

func (c CandidateState) Has(s CandidateState) bool

Returns true if ALL states in s are active. Logical AND.

func (CandidateState) HasAny

func (c CandidateState) HasAny(s CandidateState) bool

Returns true if ANY state in s is active. Logical OR.

type Config

type Config struct {
	Seats               int
	Ballots             Ballots
	Candidates          []string
	WithdrawnCandidates []int
	DisableDetail       bool
}

type Detail

type Detail struct {
	Candidates int
	Ballots    int
	Seats      int
	Precision  int
	Elected    []string
	Withdrawn  []string
	Rounds     []Round
}

func (Detail) WriteReport

func (d Detail) WriteReport(wr io.Writer) error

type Result

type Result struct {
	Elected   []string
	Withdrawn []string
	Detail    *Detail
}

func Count

func Count(config Config) (Result, error)

type Round

type Round struct {
	Number     int
	Quota      int64
	Exhausted  int64
	Candidates []Candidate
	// contains filtered or unexported fields
}

func (Round) Describe

func (round Round) Describe() string

func (Round) Events

func (round Round) Events() []event.Event

type WichmannHillRandom

type WichmannHillRandom interface {
	Next() float64
	NextInt(n int) int
}

Implementation based on: "Algorithm AS 183: An Efficient and Portable Pseudo-Random Number Generator" by B. A. Wichmann and I. D. Hill.

func NewWichmannHillRandom

func NewWichmannHillRandom(s1, s2, s3 int) WichmannHillRandom

Each seed should be a value between 1 and 30000.