R/pp_hpp.R

In ppdiag: Diagnosis and Visualizations Tools for Temporal Point Processes

#' Create a homogeneous Poisson process object
#'
#' Create a homogeneous Poisson object according to given parameters:
#' lambda, and events.
#' If events are missing, then it means that data will be
#' added later(simulated from this process).
#' @param lambda rate of the Poisson process
#' @param events event times, optional
#'
#' @return hpp object
#' @export
#' @examples
#' pp_hpp(lambda = 1)
pp_hpp <- function(lambda, events = NULL) {
  y <- c(list(lambda = lambda, events = events))
  class(y) <- "hpp"
  return(y)
}


#' @export
print.hpp <- function(x, ...) {
  cat("Homogeneous Poisson Process \n")
  cat("lambda ", x$lambda0, "\n")
  if(!(is.null(x$events))) {
    cat("events", x$events, "\n") 
  }
  invisible(NULL)
}