swarm-0.7.0.0: 2D resource gathering game with programmable robots
LicenseBSD-3-Clause
Safe HaskellNone
LanguageHaskell2010

Swarm.Game.Scenario.Scoring.GenericMetrics

Description

Data types and functions applicable across different scoring methods.

Synopsis

Documentation

data Progress Source #

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

Constructors

Attempted 
Completed 

Instances

Instances details
FromJSON Progress Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

parseJSON :: Value -> Parser Progress #

parseJSONList :: Value -> Parser [Progress] #

omittedField :: Maybe Progress #

ToJSON Progress Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

toJSON :: Progress -> Value #

toEncoding :: Progress -> Encoding #

toJSONList :: [Progress] -> Value #

toEncodingList :: [Progress] -> Encoding #

omitField :: Progress -> Bool #

Generic Progress Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Associated Types

type Rep Progress 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

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

Methods

from :: Progress -> Rep Progress x #

to :: Rep Progress x -> Progress #

Read Progress Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

readsPrec :: Int -> ReadS Progress #

readList :: ReadS [Progress] #

readPrec :: ReadPrec Progress #

readListPrec :: ReadPrec [Progress] #

Show Progress Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

showsPrec :: Int -> Progress -> ShowS #

show :: Progress -> String #

showList :: [Progress] -> ShowS #

Eq Progress Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

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

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

Ord Progress Source # 
Instance details

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 Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

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

data Metric a Source #

Constructors

Metric Progress a 

Instances

Instances details
FromJSON a => FromJSON (Metric a) Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

parseJSON :: Value -> Parser (Metric a) #

parseJSONList :: Value -> Parser [Metric a] #

omittedField :: Maybe (Metric a) #

ToJSON a => ToJSON (Metric a) Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

toJSON :: Metric a -> Value #

toEncoding :: Metric a -> Encoding #

toJSONList :: [Metric a] -> Value #

toEncodingList :: [Metric a] -> Encoding #

omitField :: Metric a -> Bool #

Generic (Metric a) Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Associated Types

type Rep (Metric a) 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

type Rep (Metric a) = D1 ('MetaData "Metric" "Swarm.Game.Scenario.Scoring.GenericMetrics" "swarm-0.7.0.0-IuFfgHrMoE7JrptOBRVOwx-swarm-engine" 'False) (C1 ('MetaCons "Metric" 'PrefixI 'True) (S1 ('MetaSel ('Just "_metricProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Progress) :*: S1 ('MetaSel ('Just "_metricData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a)))

Methods

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

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

Read a => Read (Metric a) Source # 
Instance details

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) Source # 
Instance details

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) Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

Methods

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

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

Ord a => Ord (Metric a) Source # 
Instance details

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) Source # 
Instance details

Defined in Swarm.Game.Scenario.Scoring.GenericMetrics

type Rep (Metric a) = D1 ('MetaData "Metric" "Swarm.Game.Scenario.Scoring.GenericMetrics" "swarm-0.7.0.0-IuFfgHrMoE7JrptOBRVOwx-swarm-engine" 'False) (C1 ('MetaCons "Metric" 'PrefixI 'True) (S1 ('MetaSel ('Just "_metricProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Progress) :*: S1 ('MetaSel ('Just "_metricData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a)))

metricProgress :: forall a f. Functor f => (Progress -> f Progress) -> Metric a -> f (Metric a) Source #

The player progress, so that we know if this game was completed.

metricData :: forall a f. Functor f => (a -> f a) -> Metric a -> f (Metric a) Source #

Metric data, for example start and end time.

chooseBetter Source #

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.