bf.dist.laplace: Laplace Distribution

In BayesForge: Bayesian Inference using 'numpyro' and 'XLA'

Laplace Distribution

Description

Samples from a Laplace distribution, also known as the double exponential distribution. The Laplace distribution is defined by its location parameter (loc) and scale parameter (scale).

Usage

bf.dist.laplace(
  loc = 0,
  scale = 1,
  validate_args = py_none(),
  name = "x",
  obs = py_none(),
  mask = py_none(),
  sample = FALSE,
  seed = py_none(),
  shape = c(),
  event = 0,
  create_obj = FALSE,
  to_jax = TRUE
)

Arguments

loc	A numeric vector representing the location parameter of the Laplace distribution.
scale	A numeric vector representing the scale parameter of the Laplace distribution. Must be positive.
validate_args	Logical: Whether to validate parameter values. Defaults to 'reticulate::py_none()'.
name	A character string representing the name of the random variable within a model. This is used to uniquely identify the variable. Defaults to 'x'.
obs	A numeric vector or array of observed values. If provided, the random variable is conditioned on these values. If 'NULL', the variable is treated as a latent (unobserved) variable. Defaults to 'NULL'.
mask	A logical vector, optionally used to mask observations.
sample	A logical value that controls the function's behavior. If 'TRUE', the function will directly draw samples from the distribution. If 'FALSE', it will create a random variable within a model. Defaults to 'FALSE'.
seed	An integer used to set the random seed for reproducibility when 'sample = TRUE'. This argument has no effect when 'sample = FALSE', as randomness is handled by the model's inference engine. Defaults to 0.
shape	A numeric vector used for shaping. When sample=FALSE (model building), this is used with ‘.expand(shape)' to set the distribution’s batch shape. When sample=TRUE (direct sampling), this is used as 'sample_shape' to draw a raw JAX array of the given shape.
event	Integer representing the number of batch dimensions to reinterpret as event dimensions (used in model building).
create_obj	Logical; If TRUE, returns the raw BI distribution object instead of creating a sample site. This is essential for building complex distributions like 'MixtureSameFamily'.
to_jax	Logical. Defaults to TRUE.

Value

- When sample=FALSE: A BI Laplace distribution object (for model building).

- When sample=TRUE: A JAX array of samples drawn from the Laplace distribution (for direct sampling).

- When create_obj=TRUE: The raw BI distribution object (for advanced use cases).

See Also

This is a wrapper of https://num.pyro.ai/en/stable/distributions.html#laplace

Examples

library(BayesForge)
m <- importBF(platform = "cpu")
bf.dist.laplace(sample = TRUE)

BayesForge documentation built on June 9, 2026, 1:09 a.m.