use runmat_builtins::{
BuiltinCompletionPolicy, BuiltinDescriptor, BuiltinErrorDescriptor, BuiltinOutputMode,
BuiltinParamArity, BuiltinParamDescriptor, BuiltinParamType, BuiltinSignatureDescriptor,
ResolveContext, Tensor, Type, Value,
};
use runmat_macros::runtime_builtin;
use crate::build_runtime_error;
use crate::builtins::common::random;
use crate::builtins::common::random_args::extract_dims;
use crate::builtins::common::tensor;
const BUILTIN_NAME: &str = "exprnd";
const EXPRND_OUTPUT_R: [BuiltinParamDescriptor; 1] = [BuiltinParamDescriptor {
name: "r",
ty: BuiltinParamType::NumericArray,
arity: BuiltinParamArity::Required,
default: None,
description: "Random sample array from exponential distribution.",
}];
const EXPRND_INPUTS_MU: [BuiltinParamDescriptor; 1] = [BuiltinParamDescriptor {
name: "mu",
ty: BuiltinParamType::Any,
arity: BuiltinParamArity::Required,
default: None,
description: "Exponential mean parameter (must be > 0).",
}];
const EXPRND_INPUTS_MU_SZ: [BuiltinParamDescriptor; 2] = [
BuiltinParamDescriptor {
name: "mu",
ty: BuiltinParamType::Any,
arity: BuiltinParamArity::Required,
default: None,
description: "Exponential mean parameter (must be > 0).",
},
BuiltinParamDescriptor {
name: "sz",
ty: BuiltinParamType::Any,
arity: BuiltinParamArity::Required,
default: None,
description: "Size scalar or size vector argument.",
},
];
const EXPRND_INPUTS_MU_DIMS: [BuiltinParamDescriptor; 2] = [
BuiltinParamDescriptor {
name: "mu",
ty: BuiltinParamType::Any,
arity: BuiltinParamArity::Required,
default: None,
description: "Exponential mean parameter (must be > 0).",
},
BuiltinParamDescriptor {
name: "sz",
ty: BuiltinParamType::Any,
arity: BuiltinParamArity::Variadic,
default: None,
description: "Dimension extents for output shape.",
},
];
const EXPRND_SIGNATURES: [BuiltinSignatureDescriptor; 3] = [
BuiltinSignatureDescriptor {
label: "r = exprnd(mu)",
inputs: &EXPRND_INPUTS_MU,
outputs: &EXPRND_OUTPUT_R,
},
BuiltinSignatureDescriptor {
label: "r = exprnd(mu, sz)",
inputs: &EXPRND_INPUTS_MU_SZ,
outputs: &EXPRND_OUTPUT_R,
},
BuiltinSignatureDescriptor {
label: "r = exprnd(mu, sz1, sz2, ...)",
inputs: &EXPRND_INPUTS_MU_DIMS,
outputs: &EXPRND_OUTPUT_R,
},
];
const EXPRND_ERROR_MU_MUST_BE_POSITIVE: BuiltinErrorDescriptor = BuiltinErrorDescriptor {
code: "RM.EXPRND.MU_MUST_BE_POSITIVE",
identifier: Some("RunMat:exprnd:MuMustBePositive"),
when: "mu is zero or negative.",
message: "exprnd: mu must be greater than zero",
};
const EXPRND_ERROR_INVALID_ARGUMENT: BuiltinErrorDescriptor = BuiltinErrorDescriptor {
code: "RM.EXPRND.INVALID_ARGUMENT",
identifier: Some("RunMat:exprnd:InvalidArgument"),
when: "Input parameters or size arguments are missing or malformed.",
message: "exprnd: invalid argument",
};
const EXPRND_ERROR_INTERNAL: BuiltinErrorDescriptor = BuiltinErrorDescriptor {
code: "RM.EXPRND.INTERNAL",
identifier: Some("RunMat:exprnd:Internal"),
when: "Internal conversion/allocation/provider decode fails.",
message: "exprnd: internal operation failed",
};
const EXPRND_ERRORS: [BuiltinErrorDescriptor; 3] = [
EXPRND_ERROR_MU_MUST_BE_POSITIVE,
EXPRND_ERROR_INVALID_ARGUMENT,
EXPRND_ERROR_INTERNAL,
];
pub const EXPRND_DESCRIPTOR: BuiltinDescriptor = BuiltinDescriptor {
signatures: &EXPRND_SIGNATURES,
output_mode: BuiltinOutputMode::Fixed,
completion_policy: BuiltinCompletionPolicy::Public,
errors: &EXPRND_ERRORS,
};
fn exprnd_error_with(
error: &'static BuiltinErrorDescriptor,
message: impl Into<String>,
) -> crate::RuntimeError {
let mut builder = build_runtime_error(message).with_builtin(BUILTIN_NAME);
if let Some(identifier) = error.identifier {
builder = builder.with_identifier(identifier);
}
builder.build()
}
fn exprnd_error(error: &'static BuiltinErrorDescriptor) -> crate::RuntimeError {
exprnd_error_with(error, error.message)
}
fn exprnd_internal_error(message: impl Into<String>) -> crate::RuntimeError {
exprnd_error_with(&EXPRND_ERROR_INTERNAL, message)
}
fn exprnd_type(args: &[Type], _ctx: &ResolveContext) -> Type {
if args.len() <= 1 {
Type::Num
} else {
Type::Unknown
}
}
#[runtime_builtin(
name = "exprnd",
category = "stats/random",
summary = "Generate exponentially distributed random samples with mean `mu`.",
keywords = "exprnd,exponential,random,distribution,statistics",
type_resolver(exprnd_type),
descriptor(crate::builtins::stats::random::exprnd::EXPRND_DESCRIPTOR),
builtin_path = "crate::builtins::stats::random::exprnd"
)]
async fn exprnd_builtin(args: Vec<Value>) -> crate::BuiltinResult<Value> {
let (mu, shape) = parse_args(args).await?;
if mu <= 0.0 {
return Err(exprnd_error(&EXPRND_ERROR_MU_MUST_BE_POSITIVE));
}
if let Some(value) = try_gpu_exponential(mu, &shape)? {
return Ok(value);
}
let len = tensor::element_count(&shape);
let data = random::generate_exponential(mu, len, "exprnd")?;
let t = Tensor::new(data, shape).map_err(|e| exprnd_internal_error(format!("exprnd: {e}")))?;
Ok(tensor::tensor_into_value(t))
}
async fn parse_args(args: Vec<Value>) -> crate::BuiltinResult<(f64, Vec<usize>)> {
if args.is_empty() {
return Err(exprnd_error_with(
&EXPRND_ERROR_INVALID_ARGUMENT,
"exprnd: requires at least one argument (mu)",
));
}
let mu = scalar_f64(&args[0])?;
let shape = parse_shape_args(&args[1..]).await?;
Ok((mu, shape))
}
fn scalar_f64(value: &Value) -> crate::BuiltinResult<f64> {
match value {
Value::Num(v) => Ok(*v),
Value::Int(i) => Ok(i.to_f64()),
Value::Bool(b) => Ok(if *b { 1.0 } else { 0.0 }),
other => Err(exprnd_error_with(
&EXPRND_ERROR_INVALID_ARGUMENT,
format!("exprnd: expected scalar parameter, got {other:?}"),
)),
}
}
async fn parse_shape_args(rest: &[Value]) -> crate::BuiltinResult<Vec<usize>> {
if rest.is_empty() {
return Ok(vec![1, 1]);
}
let mut dims: Vec<usize> = Vec::new();
for arg in rest {
match extract_dims(arg, "exprnd").await? {
Some(d) => dims.extend(d),
None => {
return Err(exprnd_error_with(
&EXPRND_ERROR_INVALID_ARGUMENT,
format!("exprnd: invalid size argument: {arg:?}"),
))
}
}
}
Ok(normalize_dims(dims))
}
fn normalize_dims(dims: Vec<usize>) -> Vec<usize> {
if dims.is_empty() {
vec![0, 0]
} else if dims.len() == 1 {
vec![dims[0], dims[0]]
} else {
dims
}
}
fn try_gpu_exponential(mu: f64, shape: &[usize]) -> crate::BuiltinResult<Option<Value>> {
let Some(provider) = runmat_accelerate_api::provider() else {
return Ok(None);
};
if provider.precision() != runmat_accelerate_api::ProviderPrecision::F64 {
return Ok(None);
}
match provider.random_exponential(mu, shape) {
Ok(handle) => {
let len = tensor::element_count(shape);
random::skip_uniform(len, "exprnd")?;
Ok(Some(Value::GpuTensor(handle)))
}
Err(_) => Ok(None),
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::builtins::common::random;
use futures::executor::block_on;
fn reset() {
runmat_accelerate_api::clear_provider();
random::reset_rng();
}
#[test]
fn exprnd_scalar_deterministic() {
let _guard = random::test_lock().lock().unwrap();
reset();
let result = block_on(exprnd_builtin(vec![Value::Num(2.0)])).expect("exprnd");
let expected = random::expected_exponential_sequence(2.0, 1)[0];
match result {
Value::Num(v) => {
assert!(v > 0.0);
assert!((v - expected).abs() < 1e-12);
}
other => panic!("expected scalar, got {other:?}"),
}
}
#[test]
fn exprnd_matrix_dims() {
let _guard = random::test_lock().lock().unwrap();
reset();
let args = vec![Value::Num(1.0), Value::Num(3.0), Value::Num(4.0)];
let result = block_on(exprnd_builtin(args)).expect("exprnd");
match result {
Value::Tensor(t) => {
assert_eq!(t.shape, vec![3, 4]);
assert!(t.data.iter().all(|&v| v > 0.0));
}
other => panic!("expected tensor, got {other:?}"),
}
}
#[test]
fn exprnd_size_vec() {
let _guard = random::test_lock().lock().unwrap();
reset();
let size = Tensor::new(vec![3.0, 4.0], vec![1, 2]).unwrap();
let args = vec![Value::Num(1.0), Value::Tensor(size)];
let result = block_on(exprnd_builtin(args)).expect("exprnd");
match result {
Value::Tensor(t) => assert_eq!(t.shape, vec![3, 4]),
other => panic!("expected tensor, got {other:?}"),
}
}
#[test]
fn exprnd_rejects_negative_mu() {
let args = vec![Value::Num(-1.0)];
let err = block_on(exprnd_builtin(args)).expect_err("negative mu should error");
assert_eq!(
err.identifier(),
EXPRND_ERROR_MU_MUST_BE_POSITIVE.identifier
);
}
#[test]
fn exprnd_rejects_zero_mu() {
let args = vec![Value::Num(0.0)];
let err = block_on(exprnd_builtin(args)).expect_err("zero mu should error");
assert_eq!(
err.identifier(),
EXPRND_ERROR_MU_MUST_BE_POSITIVE.identifier
);
}
#[test]
fn exprnd_distribution_mean() {
let _guard = random::test_lock().lock().unwrap();
reset();
let mu = 3.0_f64;
let n = 50_000_usize;
let args = vec![Value::Num(mu), Value::Num(n as f64), Value::Num(1.0)];
let result = block_on(exprnd_builtin(args)).expect("exprnd");
let data = match result {
Value::Tensor(t) => t.data,
other => panic!("expected tensor, got {other:?}"),
};
let mean = data.iter().sum::<f64>() / data.len() as f64;
assert!(
(mean - mu).abs() / mu < 0.05,
"sample mean {mean:.4} not within 5% of mu={mu}"
);
}
}