The function mk_event_inhomogeneous_poisson
is used to create an event with intensity type inhomogeneous Poisson (time dependent intensity which does not depend on population).
When the event occurs, something happens in the population.
The created event must be used with mk_model
.
Arguments
- type
Must be one of
'birth'
,'death'
,'entry'
,'exit'
,'swap'
or'custom'
. See details.- name
(Optional) If not specified, the name given to the event is its type.
- intensity_code
String containing some C++ code describing the intensity function. See details.
- kernel_code
String containing some C++ code describing the event action. Optional for
'birth'
,'death'
and'exit'
events. See details.
Details
The type
argument is one of the following
'birth'
By default, a new individual
newI
is created, with the same characteristics of the parentI
and birth date equal to the current time. Optional code can be precised inkernel_code
.'death'
By default, the individual
I
dies. Optional code can be precised inkernel_code
.'entry'
A new individual
newI
is added to the population, and its characteristics have to be defined by the user in the entrykernel_code
.'exit'
An individual
I
exits from the population. Optional code can be precised inkernel_code
.'swap'
The user can change the characteristics of the selected individual
I
. This requireskernel_code
.'custom'
None of the above types, the user defines
kernel_code
that can act on the selected individualI
and on the populationpop
.
The intensity_code
argument is a string containing some C++ code describing the event intensity for individual I
at time t
. The intensity value must be stored in the variable result
.
Some of available variables in the C++ code are: t
(the current time), I
(the current individual selected for the event), the name of the model parameters (some variables, or functions, see mk_model
).
See vignette('IBMPopSim_Cpp')
for more details.
The kernel_code
argument is a string containing some C++ code which describing the action of the event. Some of available variables in the C++ code are: t
(the current time), pop
(the current population), I
(the current individual selected for the event), newI
(the new individual if 'birth'
or 'entry'
event), the name of the model parameters (some variables, or functions, see mk_model
).
See vignette('IBMPopSim')
for more details.