protocol

Documentation

Index

• Variables
• type Candidate
• type Election
• type Protocol
• type SimpleMajority
  • func (election *SimpleMajority) Cast(vote Vote)
  • func (election *SimpleMajority) Display()
  • func (election *SimpleMajority) GetId() string
  • func (election *SimpleMajority) Init(candidates []Candidate)
  • func (election *SimpleMajority) Result() ([]string, float64)
  • func (election *SimpleMajority) Tally()
  • func (election *SimpleMajority) ValidateVote(vote Vote) bool
• type Vote

Variables

var ProtocolCommandMap = map[string]Protocol{
	"simpleMajority": new(SimpleMajority),
}

Consumed by cmd/serve.go

Types

type Candidate

type Candidate struct {
	Name string
}

type Election

type Election struct {
	Id         string
	Name       string
	Candidates []Candidate
	Votes      []Vote
	Totals     map[string]float64 // Candidate name to their total
}

type Protocol

type Protocol interface {
	Init([]Candidate)
	Cast(Vote)                   // Cast a vote
	Tally()                      // Compute the candidate's totals
	Result() ([]string, float64) // Get the final result(s)
	Display()                    // Print the current totals
	GetId() string               // Get the id of the election
	ValidateVote(Vote) bool      // Return if a cast vote is valid
}

type SimpleMajority

type SimpleMajority struct {
	Election
}

func (*SimpleMajority) Cast

func (election *SimpleMajority) Cast(vote Vote)

func (*SimpleMajority) Display

func (election *SimpleMajority) Display()

func (*SimpleMajority) GetId

func (election *SimpleMajority) GetId() string

func (*SimpleMajority) Init

func (election *SimpleMajority) Init(candidates []Candidate)

func (*SimpleMajority) Result

func (election *SimpleMajority) Result() ([]string, float64)

func (*SimpleMajority) Tally

func (election *SimpleMajority) Tally()

func (*SimpleMajority) ValidateVote

func (election *SimpleMajority) ValidateVote(vote Vote) bool

type Vote

type Vote struct {
	Value     float64
	Candidate Candidate
}