Language.Nomyx.Vote

Voting system

Documentation

data VoteType a

Constructors

ExclusiveVote (Maybe (Alts a))

NonExclusiveVote [Alts a]

class (Eq (Alts a), Show (Alts a), Ord (Alts a), Typeable a) => Votable a where

Associated Types

data Alts a

Methods

alts :: [Alts a]

quota :: Alts a -> Int -> Int -> Int

name :: a -> String

exclusiveWinner :: a -> Maybe (Alts a, Alts a)

Instances

Votable RuleInfo

Votable Election

Votable Referendum

type ForAgainst = Alts RuleInfo

type Vote a = (PlayerNumber, Maybe (Alts a))

type VoteResult a = VoteStats a -> [Alts a]

data VoteStats a

Constructors

VoteStats

Fields

voteCounts :: Map (Maybe (Alts a)) Int

voteFinished :: Bool

data VoteData a

Constructors

VoteData

Fields

msgEnd :: Msg [Alts a]

voteVar :: ArrayVar PlayerNumber (Alts a)

inputNumbers :: [EventNumber]

assessFunction :: VoteResult a

timeLimit :: Maybe UTCTime

type Assessor a = StateT (VoteData a) Nomex ()

voteWith

Arguments

:: Votable a

=> VoteResult a

the function used to count the votes.

-> Assessor a

assessors: when and how to perform the vote assessment (several assessors can be chained).

-> a

toVote: the matter to be voted.

-> [Alts a]

the vote alternatives.

-> Nomex (Msg [Alts a])

return value: a message containing the result of the vote.

Perform a vote.

voteWith_ :: Votable a => VoteResult a -> Assessor a -> a -> Nomex (Msg [Alts a])

Performs a vote, all the possible alternatives are selected.

assessOnEveryVote :: Votable a => Assessor a

assess the vote on every new vote with the assess function, and as soon as the vote has an issue (positive of negative), sends a signal

assessOnTimeLimit :: Votable a => UTCTime -> Assessor a

assess the vote with the assess function when time is reached, and sends a signal with the issue (positive of negative)

assessOnTimeDelay :: Votable a => NominalDiffTime -> Assessor a

assess the vote with the assess function when time is elapsed, and sends a signal with the issue (positive of negative)

assessWhenEverybodyVoted :: Votable a => Assessor a

assess the vote only when every body voted. An error is generated if the assessing function returns Nothing.

cleanVote :: Votable a => VoteData a -> Nomex EventNumber

clean events and variables necessary for the vote

quorum :: Votable a => Int -> VoteStats a -> Bool

a quorum is the neccessary number of voters for the validity of the vote

withQuorum :: Votable a => VoteResult a -> Int -> VoteResult a

adds a quorum to an assessing function

unanimity :: Votable a => VoteStats a -> [Alts a]

assess the vote results according to a unanimity (everybody votes for)

majority :: Votable a => VoteStats a -> [Alts a]

assess the vote results according to an absolute majority (half voters plus one, no quorum is needed)

majorityWith :: Votable a => Int -> VoteStats a -> [Alts a]

assess the vote results according to a majority of x (in %)

numberVotes :: Votable a => Int -> VoteStats a -> [Alts a]

assess the vote results according to a necessary number of positive votes

firstXBest :: forall a. Votable a => Int -> VoteStats a -> [Alts a]

the winners are the x vote alternatives with the more votes

takeInGroups :: Int -> [[a]] -> [a]

firstBest :: Votable a => VoteStats a -> [Alts a]

the winner is the vote alternative with the more votes

sortWith :: Ord b => (a -> b) -> [a] -> [a]

voteQuota :: forall a. Votable a => Int -> VoteStats a -> [Alts a]

return the vote alternatives that are above threshold

exclusiveVoteQuota :: Votable a => Int -> VoteStats a -> (Alts a, Alts a) -> Maybe (Alts a)

in case of exclusive winner

nbVoters :: Votable a => VoteStats a -> Int

number of people that voted if the voting is finished, total number of people that should vote otherwise

totalVoters :: Votable a => VoteStats a -> Int

notVoted :: Votable a => VoteStats a -> Int

voted :: Votable a => VoteStats a -> Int

getVoteStats :: Votable a => [Vote a] -> Bool -> VoteStats a

counts :: (Eq a, Ord a) => [a] -> [(a, Int)]

displayVoteVar :: Votable a => Maybe PlayerNumber -> String -> ArrayVar PlayerNumber (Alts a) -> Nomex EventNumber

showChoice :: Votable a => Maybe (Alts a) -> String

showChoices :: Votable a => [Alts a] -> String

showOnGoingVote :: Votable a => String -> [(PlayerNumber, Maybe (Alts a))] -> NomexNE String

showFinishedVote :: Votable a => [(PlayerNumber, Maybe (Alts a))] -> NomexNE String

showVote :: Votable a => (PlayerNumber, Maybe (Alts a)) -> NomexNE (String, String)

displayVoteResult :: Votable a => String -> VoteData a -> Nomex OutputNumber

onRuleProposed :: (RuleInfo -> Nomex (Msg [ForAgainst])) -> Rule

any new rule will be activate if the rule in parameter returns For

Referendum & elections

data Referendum

Constructors

Referendum String

Instances

Typeable Referendum

Votable Referendum

Bounded (Alts Referendum)

Enum (Alts Referendum)

Eq (Alts Referendum)

Ord (Alts Referendum)

Read (Alts Referendum)

Show (Alts Referendum)

referendum :: String -> Nomex () -> Rule

data Election

Constructors

Election String

Instances

Typeable Election

Votable Election

Eq (Alts Election)

Ord (Alts Election)

Show (Alts Election)

elections :: String -> [PlayerInfo] -> (PlayerNumber -> Nomex ()) -> Nomex ()

voteEvent :: UTCTime -> [PlayerNumber] -> Event [Maybe Bool]

singleVote :: UTCTime -> PlayerNumber -> Event (Maybe Bool)

vote :: UTCTime -> [PlayerNumber] -> Event Bool

unanimity' :: [Maybe Bool] -> Bool

callVote :: UTCTime -> Nomex ()