check_nonneg_double_scalar: Check non-negative double scalar

View source: R/check.R

check_nonneg_double_scalarR Documentation

Check non-negative double scalar

Description

Check non-negative double scalar

Usage

check_nonneg_double_scalar(x, arg_name = deparse(substitute(x)))

Arguments

x

Numeric: Value to check. Must be a single finite number greater than or equal to zero.

arg_name

Character: Argument name to use in error messages.

Value

Called for side effects. Throws an error if checks fail.

Author(s)

EDG

Examples

check_nonneg_double_scalar(0)
check_nonneg_double_scalar(5)
# Throw error:
try(check_nonneg_double_scalar(-0.001))
try(check_nonneg_double_scalar(Inf))

rtemis.core documentation built on Sept. 20, 2026, 9:06 a.m.