R/K.R

Defines functions K

Documented in K

#' K
#' 
#' Returns the kinetic energy of a momentum vector. Used as an auxiliary
#' function in Hamiltonian Monte Carlo samplers.
#'
#' @param p numeric. vector of momenta.
#'
#' @return numeric. kinetic energy.
#' @export
#'
#' @examples
#' 
#' momentum <- rnorm(20)
#' K(momentum)
#' 
K <- function(p){
  # kinetic energy
  return(t(p) %*% p/2)
}
brianconroy/preferential_surveillance documentation built on Nov. 23, 2021, 5:51 a.m.