check_bounded_double_scalar: Check double scalar within bounds

In rtemis.core: Core Utilities for the 'rtemis' Ecosystem

Check double scalar within bounds

Description

Check double scalar within bounds

Usage

check_bounded_double_scalar(
  x,
  lower = -Inf,
  upper = Inf,
  lower_open = FALSE,
  upper_open = FALSE,
  arg_name = deparse(substitute(x))
)

Arguments

x	Numeric: Value to check. Must be a single finite non-NA number.
lower	Numeric scalar: Lower bound.
upper	Numeric scalar: Upper bound.
lower_open	Logical scalar: If TRUE, the lower bound is exclusive.
upper_open	Logical scalar: If TRUE, the upper bound is exclusive.
arg_name	Character: Argument name to use in error messages.

Details

For bounds not covered by the fixed-range checks (check_prob_scalar is ⁠[0, 1]⁠, check_pos_double_scalar is ⁠(0, Inf)⁠), or where the range is not known until runtime. The argument-checking counterpart to prop_float, whose min/max and exclusive_min/exclusive_max describe the same intervals for a config class. Finite like it: Inf/-Inf are rejected even where the matching bound is unbounded, since an infinite bound is always an open one.

Value

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

Author(s)

EDG

Examples

check_bounded_double_scalar(0.7, lower = 0, upper = 2)
# Learning rate in (0, 1]
check_bounded_double_scalar(0.1, lower = 0, upper = 1, lower_open = TRUE)
# Throw error:
try(check_bounded_double_scalar(5, lower = 0, upper = 2))
try(check_bounded_double_scalar(Inf, lower = 0))

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