Swarm.Game.Scenario.Scoring.GenericMetrics

Data types and functions applicable across different scoring methods.

Documentation

data Progress

This is a subset of the ScenarioStatus type that excludes the NotStarted case.

Constructors

Attempted

Completed

Instances

FromJSON Progress

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

parseJSON :: Value -> Parser Progress

parseJSONList :: Value -> Parser [Progress]

ToJSON Progress

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

toJSON :: Progress -> Value

toEncoding :: Progress -> Encoding

toJSONList :: [Progress] -> Value

toEncodingList :: [Progress] -> Encoding

Generic Progress

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Associated Types

type Rep Progress :: Type -> Type

Methods

from :: Progress -> Rep Progress x

to :: Rep Progress x -> Progress

Read Progress

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

readsPrec :: Int -> ReadS Progress

readList :: ReadS [Progress]

readPrec :: ReadPrec Progress

readListPrec :: ReadPrec [Progress]

Show Progress

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

showsPrec :: Int -> Progress -> ShowS

show :: Progress -> String

showList :: [Progress] -> ShowS

Eq Progress

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

(==) :: Progress -> Progress -> Bool

(/=) :: Progress -> Progress -> Bool

Ord Progress

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

compare :: Progress -> Progress -> Ordering

(<) :: Progress -> Progress -> Bool

(<=) :: Progress -> Progress -> Bool

(>) :: Progress -> Progress -> Bool

(>=) :: Progress -> Progress -> Bool

max :: Progress -> Progress -> Progress

min :: Progress -> Progress -> Progress

type Rep Progress

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

type Rep Progress = D1 ('MetaData "Progress" "Swarm.Game.Scenario.Scoring.GenericMetrics" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "Attempted" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Completed" 'PrefixI 'False) (U1 :: Type -> Type))

untaggedJsonOptions :: Options

data Metric a

Constructors

Metric Progress a

Instances

FromJSON a => FromJSON (Metric a)

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

parseJSON :: Value -> Parser (Metric a)

parseJSONList :: Value -> Parser [Metric a]

ToJSON a => ToJSON (Metric a)

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

toJSON :: Metric a -> Value

toEncoding :: Metric a -> Encoding

toJSONList :: [Metric a] -> Value

toEncodingList :: [Metric a] -> Encoding

Generic (Metric a)

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Associated Types

type Rep (Metric a) :: Type -> Type

Methods

from :: Metric a -> Rep (Metric a) x

to :: Rep (Metric a) x -> Metric a

Read a => Read (Metric a)

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

readsPrec :: Int -> ReadS (Metric a)

readList :: ReadS [Metric a]

readPrec :: ReadPrec (Metric a)

readListPrec :: ReadPrec [Metric a]

Show a => Show (Metric a)

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

showsPrec :: Int -> Metric a -> ShowS

show :: Metric a -> String

showList :: [Metric a] -> ShowS

Eq a => Eq (Metric a)

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

(==) :: Metric a -> Metric a -> Bool

(/=) :: Metric a -> Metric a -> Bool

Ord a => Ord (Metric a)

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

compare :: Metric a -> Metric a -> Ordering

(<) :: Metric a -> Metric a -> Bool

(<=) :: Metric a -> Metric a -> Bool

(>) :: Metric a -> Metric a -> Bool

(>=) :: Metric a -> Metric a -> Bool

max :: Metric a -> Metric a -> Metric a

min :: Metric a -> Metric a -> Metric a

type Rep (Metric a)

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

type Rep (Metric a) = D1 ('MetaData "Metric" "Swarm.Game.Scenario.Scoring.GenericMetrics" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "Metric" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Progress) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a)))

getMetric :: Metric a -> a

chooseBetter

Arguments

:: Ord a

=> (b -> Maybe a)

criteria; record field extractor

-> Metric b

x

-> Metric b

y

-> Metric b

This encodes the notion of "more play is better" for incomplete games (rationale: more play = more fun), whereas "smaller inputs are better" for completed games.

Since Maybe has its own Ord instance where Nothing < Just x regardless of x, when we want to choose the minimum value we fmap Down to ensure that the Just is selected while inverting the ordering of the inner member.