multSim: Multiple simulations of a pdmp model

In CharlotteJana/pdmpsim: Simulate Piecewise Deterministic Markov Processes

Multiple simulations of a pdmp model

Description

Perform simulations of a PDMP with different seeds and optionally save the results in a rda file.

Usage

multSim(obj, seeds, filename = NULL, ms = NULL, allowDeletion = FALSE, ...)

Arguments

obj	object of class pdmpModel or one of its subclasses
seeds	integer vector with seeds that shall be simulated (different seeds lead to different simulated trajectories)
filename	string which indicates the path where to save the result, i. e. "NameOfFile.rda". In case of a break or an error, already simulated seeds will still be saved there. If filename = NULL, the result will not be saved in a file.
ms	object of class multSim (with existing simulations) that shall be expanded
allowDeletion	logical. If true, seeds with existing simulations stored in ms will be deleted in case they don't appear in the new vector of seeds.
...	additional parameters for method sim

Details

The returned s3 class multSim contains 4 different elements:

• model containing the pdmpModel obj,

• seeds containing the integer vector seeds,

• a list outputList containing the simulation results, i.e. outputList[[i]] = sim(model, seed = seeds[i]),

• a list timeList containing the time needed for every simulation, i.e. timeList[[i]] = system.time(sim(model, seed = seeds[i]))

If an object ms of class multSim is given as parameter, method multSim will only simulate the seeds that are not simulated yet. You can control if seeds that are already simulated and stored in ms but do not appear in the parameter seeds should be deleted or not. This is done via the parameter allowDeletion.

If the time slot of obj has a larger end value than the pdmpModel stored in ms, i.e. times(obj)["to"] > times(ms$model)["to"], all existing simulations will be expanded to the larger end value.

Slot obj@out is not affected by multSim.

Value

object of class multSim containing simulations for all given seeds

See Also

There are several plot methods for objects of class multSim: plot, plotSeeds, plotTimes, plotStats, hist and density.

Examples

data("simplePdmp")
m1 <- multSim(simplePdmp, seeds = 1:10)
plot(m1$outputList[[1]])

# expand times:
times(simplePdmp)["to"] <- 20
m2 <- multSim(simplePdmp, seeds = 1:15, ms = m1)
plot(m2$outputList[[15]])

CharlotteJana/pdmpsim documentation built on Oct. 21, 2024, 4:54 p.m.