Copyright	(c) 2021 Alexander E. Zarebski
License	MIT
Maintainer	Alexander E. Zarebski <aezarebski@gmail.com>
Stability	unstable
Portability	ghc
Safe Haskell	None
Language	Haskell2010

Epidemic.Types.Population

Description

This module defines some types and functions for working with identifiers, persons, people, and populations.

An Identifier is used as a unique label for a Person,
a Person is a single individual,
a group of People is a collection of persons,
and Population is a typeclass for working with people that have some structure.

Synopsis

newtype Person = Person Identifier
newtype People = People (Vector Person)
class Population a where
- susceptiblePeople :: a -> Maybe People
- infectiousPeople :: a -> Maybe People
- removedPeople :: a -> Maybe People
- isInfected :: a -> Bool
newtype Identifier = Identifier Integer
asPeople :: [Person] -> People
includesPerson :: People -> Person -> Bool
haveCommonPeople :: People -> People -> Bool
nullPeople :: People -> Bool
numPeople :: People -> Int
addPerson :: Person -> People -> People
removePerson :: Person -> People -> People
personByteString :: Person -> Builder

Documentation

newtype Person Source #

A type to represent a single person in a group of People

Constructors

Person Identifier

Instances

Instances details

Eq Person Source #
Instance details Defined in Epidemic.Types.Population Methods (==) :: Person -> Person -> Bool # (/=) :: Person -> Person -> Bool #
Show Person Source #
Instance details Defined in Epidemic.Types.Population Methods showsPrec :: Int -> Person -> ShowS # show :: Person -> String # showList :: [Person] -> ShowS #
Generic Person Source #
Instance details Defined in Epidemic.Types.Population Associated Types type Rep Person :: Type -> Type # Methods from :: Person -> Rep Person x # to :: Rep Person x -> Person #
ToJSON Person Source #
Instance details Defined in Epidemic.Types.Population Methods toJSON :: Person -> Value # toEncoding :: Person -> Encoding # toJSONList :: [Person] -> Value # toEncodingList :: [Person] -> Encoding #
FromJSON Person Source #
Instance details Defined in Epidemic.Types.Population Methods parseJSON :: Value -> Parser Person # parseJSONList :: Value -> Parser [Person] #
type Rep Person Source #
Instance details Defined in Epidemic.Types.Population type Rep Person = D1 ('MetaData "Person" "Epidemic.Types.Population" "epi-sim-0.7.0-DViI2uXntfg6JZVuToo6fh" 'True) (C1 ('MetaCons "Person" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Identifier)))

newtype People Source #

A type to represent a population.

Constructors

People (Vector Person)

Instances

Instances details

Eq People Source #
Instance details Defined in Epidemic.Types.Population Methods (==) :: People -> People -> Bool # (/=) :: People -> People -> Bool #
Show People Source #
Instance details Defined in Epidemic.Types.Population Methods showsPrec :: Int -> People -> ShowS # show :: People -> String # showList :: [People] -> ShowS #
Generic People Source #
Instance details Defined in Epidemic.Types.Population Associated Types type Rep People :: Type -> Type # Methods from :: People -> Rep People x # to :: Rep People x -> People #
ToJSON People Source #
Instance details Defined in Epidemic.Types.Population Methods toJSON :: People -> Value # toEncoding :: People -> Encoding # toJSONList :: [People] -> Value # toEncodingList :: [People] -> Encoding #
FromJSON People Source #
Instance details Defined in Epidemic.Types.Population Methods parseJSON :: Value -> Parser People # parseJSONList :: Value -> Parser [People] #
type Rep People Source #
Instance details Defined in Epidemic.Types.Population type Rep People = D1 ('MetaData "People" "Epidemic.Types.Population" "epi-sim-0.7.0-DViI2uXntfg6JZVuToo6fh" 'True) (C1 ('MetaCons "People" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Person))))

class Population a where Source #

Class of types that can represent populations in an epidemic simulation.

Methods

susceptiblePeople :: a -> Maybe People Source #

infectiousPeople :: a -> Maybe People Source #

removedPeople :: a -> Maybe People Source #

isInfected :: a -> Bool Source #

Instances

Instances details

Population LogisticBDSDPopulation Source #
Instance details Defined in Epidemic.Model.LogisticBDSD Methods susceptiblePeople :: LogisticBDSDPopulation -> Maybe People Source # infectiousPeople :: LogisticBDSDPopulation -> Maybe People Source # removedPeople :: LogisticBDSDPopulation -> Maybe People Source # isInfected :: LogisticBDSDPopulation -> Bool Source #
Population InhomBDSCODPop Source #
Instance details Defined in Epidemic.Model.InhomogeneousBDSCOD Methods susceptiblePeople :: InhomBDSCODPop -> Maybe People Source # infectiousPeople :: InhomBDSCODPop -> Maybe People Source # removedPeople :: InhomBDSCODPop -> Maybe People Source # isInfected :: InhomBDSCODPop -> Bool Source #
Population InhomBDSPop Source #
Instance details Defined in Epidemic.Model.InhomogeneousBDS Methods susceptiblePeople :: InhomBDSPop -> Maybe People Source # infectiousPeople :: InhomBDSPop -> Maybe People Source # removedPeople :: InhomBDSPop -> Maybe People Source # isInfected :: InhomBDSPop -> Bool Source #
Population BDSCODPopulation Source #
Instance details Defined in Epidemic.Model.BDSCOD Methods susceptiblePeople :: BDSCODPopulation -> Maybe People Source # infectiousPeople :: BDSCODPopulation -> Maybe People Source # removedPeople :: BDSCODPopulation -> Maybe People Source # isInfected :: BDSCODPopulation -> Bool Source #

newtype Identifier Source #

A type to hold an integer which is unique to each Person.

Constructors

Identifier Integer

Instances

Instances details

Eq Identifier Source #
Instance details Defined in Epidemic.Types.Population Methods (==) :: Identifier -> Identifier -> Bool # (/=) :: Identifier -> Identifier -> Bool #
Show Identifier Source #
Instance details Defined in Epidemic.Types.Population Methods showsPrec :: Int -> Identifier -> ShowS # show :: Identifier -> String # showList :: [Identifier] -> ShowS #
Generic Identifier Source #
Instance details Defined in Epidemic.Types.Population Associated Types type Rep Identifier :: Type -> Type # Methods from :: Identifier -> Rep Identifier x # to :: Rep Identifier x -> Identifier #
ToJSON Identifier Source #
Instance details Defined in Epidemic.Types.Population Methods toJSON :: Identifier -> Value # toEncoding :: Identifier -> Encoding # toJSONList :: [Identifier] -> Value # toEncodingList :: [Identifier] -> Encoding #
FromJSON Identifier Source #
Instance details Defined in Epidemic.Types.Population Methods parseJSON :: Value -> Parser Identifier # parseJSONList :: Value -> Parser [Identifier] #
type Rep Identifier Source #
Instance details Defined in Epidemic.Types.Population type Rep Identifier = D1 ('MetaData "Identifier" "Epidemic.Types.Population" "epi-sim-0.7.0-DViI2uXntfg6JZVuToo6fh" 'True) (C1 ('MetaCons "Identifier" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

asPeople :: [Person] -> People Source #

A list of persons as a people

includesPerson :: People -> Person -> Bool Source #

Predicate for whether a person is one of the people

haveCommonPeople :: People -> People -> Bool Source #

Predicate for whether two sets of people have any members in common.

nullPeople :: People -> Bool Source #

Predicate for whether there are any people

numPeople :: People -> Int Source #

The number of people

addPerson :: Person -> People -> People Source #

Add a person to a group of people

removePerson :: Person -> People -> People Source #

Remove a person from a group of people

personByteString :: Person -> Builder Source #

A bytestring builder for a person