meekstv

README

meekstv

An implementation of Algorithm 123 - single transferable vote by Meek's Method

Background and specifications: https://svn.apache.org/repos/asf/steve/trunk/stv_background/meekm.pdf

Documentation

Index

• type BySnapshotVotes
  • func (c BySnapshotVotes) Len() int
  • func (c BySnapshotVotes) Less(i, j int) bool
  • func (c BySnapshotVotes) Swap(i, j int)
• type ByVotes
  • func (c ByVotes) Len() int
  • func (c ByVotes) Less(i, j int) bool
  • func (c ByVotes) Swap(i, j int)
• type CandidateStatus
• type MeekCandidate
  • func (meekCandidate *MeekCandidate) AsCandidate() election.Candidate
• type MeekCandidates
  • func (meekCandidates MeekCandidates) AsCandidates() election.Candidates
  • func (m MeekCandidates) Snapshot() []MeekCandidate
  • func (m MeekCandidates) SortedNames() []string
  • func (m MeekCandidates) TotalVotes() int64
• type MeekRound
• type MeekStv
  • func NewMeekStv() MeekStv
• type Pool
  • func (p *Pool) AddNewCandidates(candidates election.Candidates, scale int64)
  • func (p *Pool) AddVotes(id string, votes int64)
  • func (p *Pool) Almost() MeekCandidates
  • func (p *Pool) Candidate(id string) *MeekCandidate
  • func (p *Pool) CandidateSummaries() []election.CandidateSummary
  • func (p *Pool) Candidates() MeekCandidates
  • func (p *Pool) CandidatesWithStatus(status CandidateStatus) MeekCandidates
  • func (p *Pool) Count() int
  • func (p *Pool) Elect(id string) *MeekCandidate
  • func (p *Pool) ElectAllNewlyElected()
  • func (p *Pool) ElectHopeful()
  • func (p *Pool) Elected() MeekCandidates
  • func (p *Pool) ElectedCount() int
  • func (p *Pool) Exclude(id string) *MeekCandidate
  • func (p *Pool) ExcludeByName(name string) MeekCandidates
  • func (p *Pool) ExcludeHopeful()
  • func (p *Pool) ExcludeMany(m MeekCandidates)
  • func (p *Pool) ExcludedCount() int
  • func (p *Pool) Hopeful() MeekCandidates
  • func (p *Pool) Lowest() MeekCandidates
  • func (p *Pool) NewlyElect(id string)
  • func (p *Pool) NewlyElected() MeekCandidates
  • func (p *Pool) SetAlmost(id string)
  • func (p *Pool) SetWeight(id string, weight int64)
  • func (p *Pool) Snapshot() []MeekCandidate
  • func (p *Pool) ZeroAllVotes()

Types

type BySnapshotVotes

type BySnapshotVotes []MeekCandidate

func (BySnapshotVotes) Len

func (c BySnapshotVotes) Len() int

func (BySnapshotVotes) Less

func (c BySnapshotVotes) Less(i, j int) bool

func (BySnapshotVotes) Swap

func (c BySnapshotVotes) Swap(i, j int)

type ByVotes

type ByVotes MeekCandidates

func (ByVotes) Len

func (c ByVotes) Len() int

func (ByVotes) Less

func (c ByVotes) Less(i, j int) bool

func (ByVotes) Swap

func (c ByVotes) Swap(i, j int)

type CandidateStatus

type CandidateStatus string

const (
	Elected      CandidateStatus = "Elected"
	NewlyElected CandidateStatus = "NewlyElected"
	Hopeful      CandidateStatus = "Hopeful"
	Excluded     CandidateStatus = "Excluded"
	Almost       CandidateStatus = "Almost"
)

type MeekCandidate

type MeekCandidate struct {
	election.Candidate
	Status CandidateStatus
	Weight int64
	Votes  int64
}

func (*MeekCandidate) AsCandidate

func (meekCandidate *MeekCandidate) AsCandidate() election.Candidate

type MeekCandidates

type MeekCandidates []*MeekCandidate

func (MeekCandidates) AsCandidates

func (meekCandidates MeekCandidates) AsCandidates() election.Candidates

func (MeekCandidates) Snapshot

func (m MeekCandidates) Snapshot() []MeekCandidate

func (MeekCandidates) SortedNames

func (m MeekCandidates) SortedNames() []string

func (MeekCandidates) TotalVotes

func (m MeekCandidates) TotalVotes() int64

type MeekRound

type MeekRound struct {
	Number     int
	Excess     int64
	Surplus    int64
	AnyElected bool
	Snapshot   []MeekCandidate
}

type MeekStv

type MeekStv interface {
	election.Counter
}

func NewMeekStv

func NewMeekStv() MeekStv

type Pool

type Pool struct {
	MeekCandidates MeekCandidates
}

func (*Pool) AddNewCandidates

func (p *Pool) AddNewCandidates(candidates election.Candidates, scale int64)

func (*Pool) AddVotes

func (p *Pool) AddVotes(id string, votes int64)

func (*Pool) Almost

func (p *Pool) Almost() MeekCandidates

func (*Pool) Candidate

func (p *Pool) Candidate(id string) *MeekCandidate

func (*Pool) CandidateSummaries

func (p *Pool) CandidateSummaries() []election.CandidateSummary

func (*Pool) Candidates

func (p *Pool) Candidates() MeekCandidates

func (*Pool) CandidatesWithStatus

func (p *Pool) CandidatesWithStatus(status CandidateStatus) MeekCandidates

func (*Pool) Count

func (p *Pool) Count() int

func (*Pool) Elect

func (p *Pool) Elect(id string) *MeekCandidate

func (*Pool) ElectAllNewlyElected

func (p *Pool) ElectAllNewlyElected()

func (*Pool) ElectHopeful

func (p *Pool) ElectHopeful()

func (*Pool) Elected

func (p *Pool) Elected() MeekCandidates

func (*Pool) ElectedCount

func (p *Pool) ElectedCount() int

func (*Pool) Exclude

func (p *Pool) Exclude(id string) *MeekCandidate

func (*Pool) ExcludeByName

func (p *Pool) ExcludeByName(name string) MeekCandidates

func (*Pool) ExcludeHopeful

func (p *Pool) ExcludeHopeful()

func (*Pool) ExcludeMany

func (p *Pool) ExcludeMany(m MeekCandidates)

func (*Pool) ExcludedCount

func (p *Pool) ExcludedCount() int

func (*Pool) Hopeful

func (p *Pool) Hopeful() MeekCandidates

func (*Pool) Lowest

func (p *Pool) Lowest() MeekCandidates

func (*Pool) NewlyElect

func (p *Pool) NewlyElect(id string)

func (*Pool) NewlyElected

func (p *Pool) NewlyElected() MeekCandidates

func (*Pool) SetAlmost

func (p *Pool) SetAlmost(id string)

func (*Pool) SetWeight

func (p *Pool) SetWeight(id string, weight int64)

func (*Pool) Snapshot

func (p *Pool) Snapshot() []MeekCandidate

func (*Pool) ZeroAllVotes

func (p *Pool) ZeroAllVotes()