| 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.Parameter
Description
This module defines some types and functions for working with parameters of models.
Synopsis
- class Population p => ModelParameters a p where
- rNaught :: p -> a -> AbsoluteTime -> Maybe Double
- eventRate :: p -> a -> AbsoluteTime -> Maybe Rate
- birthProb :: p -> a -> AbsoluteTime -> Maybe Probability
- eventWeights :: p -> a -> AbsoluteTime -> Maybe (Vector Double)
- type Rate = Double
- type Probability = Double
Documentation
class Population p => ModelParameters a p where Source #
Class of types that can be considered parameterisations of a epidemic model.
Methods
rNaught :: p -> a -> AbsoluteTime -> Maybe Double Source #
The basic reproduction number.
NOTE that this is not the effective reproduction number the population is included in case there is structure other than immunity that needs to be accounted for.
eventRate :: p -> a -> AbsoluteTime -> Maybe Rate Source #
The total event rate at a particular point in time.
birthProb :: p -> a -> AbsoluteTime -> Maybe Probability Source #
The probability that an event will result in an infection.
eventWeights :: p -> a -> AbsoluteTime -> Maybe (Vector Double) Source #
The unnormalised distribution across the possible events.
Instances
type Probability = Double Source #
A probability