R/hh_generator.R

Defines functions hh_geometric

Documented in hh_geometric

#' Construct a basic household generator
#'
#' @param mean_size Average size of households
#'
#' @return A household generator
#'
#' @export
hh_geometric <- function(mean_size) {
  function(init, n) {
    hh <- init + 1 + cumsum(runif(n) < (1 / mean_size))
    list(
      hh = factor(hh),
      hh_max = hh[length(hh)]
    )
  }
}
Jean-Rubin/hhsim documentation built on April 27, 2022, 12:03 a.m.