Learn R Programming

nhppp (version 1.1.1)

vdraw_sc_step_regular_cpp: Vectorized sampling from NHPPPs with piecewise constant intensities with same interval lengths (C++)

Description

Simulate a piecewise constant-rate Poisson Point Process over (t_min, t_max] (inversion method) where the intervals have the same length (are "regular").

Usage

vdraw_sc_step_regular_cpp(
  lambda_matrix = NULL,
  Lambda_matrix = NULL,
  rate_matrix_t_min = NULL,
  rate_matrix_t_max = NULL,
  t_min = NULL,
  t_max = NULL,
  tol = 10^-6,
  atmost1 = FALSE,
  report_first_K = NULL,
  report_last_K = NULL,
  budget_cap = NULL,
  atmostB = NULL,
  output = c("matrix", "long")
)

Value

a matrix of event times t, with rows corresponding to the sampled point processes, or the long event format if output = "long".

Arguments

lambda_matrix

(matrix) intensity rates, one per interval

Lambda_matrix

(matrix) integrated intensity rates at the end of each interval

rate_matrix_t_min

(scalar | vector | column matrix) is the lower bound of the time interval for each row of (Lambda|lambda)_maj_matrix. The length of this argument is the number of point processes that should be drawn.

rate_matrix_t_max

(scalar | vector | column matrix) the upper bound of the time interval for each row of (Lambda|lambda)_maj_matrix. The length of this argument is the number of point processes that should be drawn.

t_min

(scalar | vector | column matrix) is the lower bound of a subinterval of (rate_matrix_t_min, rate_matrix_t_max]. If set, times are sampled from the subinterval. If omitted, it is equivalent to rate_matrix_t_min.

t_max

(scalar | vector | column matrix) is the upper bound of a subinterval of (rate_matrix_t_min, rate_matrix_t_max]. If set, times are sampled from the subinterval. If omitted, it is equivalent to rate_matrix_t_max.

tol

(scalar, double) tolerance for the number of events

atmost1

boolean, report at most 1 event time (alias for report_first_K = 1)

report_first_K

NULL or a positive integer: report only the earliest K event times (the count law is unchanged). At most one of report_first_K/report_last_K may be set.

report_last_K

NULL or a positive integer: report only the latest K event times (ascending order; the count law is unchanged).

budget_cap

NULL or a positive integer: cap the computational event budget of the kernel. This is an approximation knob (it truncates the extreme tail of the event-count distribution together with the 1 - tol quantile bound), not an exact reporting contract.

atmostB

deprecated alias for budget_cap.

output

(string) "matrix" (default) returns the NA-padded event matrix, one row per point process. "long" returns the long event format list(id, time, n_draws) with one entry per event: id is the 1-based point-process index (ascending; times ascending within id). A point process with no events contributes no entries, so its id is absent; n_draws distinguishes "no events" from "not sampled". No NA is used. The long format is built without allocating the dense matrix, so prefer it when event counts vary widely across point processes.

Examples

Run this code
x <- vdraw_sc_step_regular_cpp(
  Lambda_matrix = matrix(1:5, nrow = 1),
  rate_matrix_t_min = 100,
  rate_matrix_t_max = 110
)

Run the code above in your browser using DataLab