is_whole_number: Very fast check that numeric vector consists only of whole...

In cheapr: Simple Functions to Save Time and Memory

Very fast check that numeric vector consists only of whole numbers

Description

Very fast check that numeric vector consists only of whole numbers

Usage

is_whole_number(x, tol = sqrt(.Machine$double.eps), na.rm = TRUE)

Arguments

x	⁠[numeric(n)]⁠ - A numeric vector.
tol	⁠[numeric(1)]⁠ - Tolerance.
na.rm	⁠[logical(1)]⁠ - Should NA values be ignored? Default is TRUE.

Details

is_whole_number() will return NA when these 3 conditions are met:

• na.rm is FALSE

• x contains at least 1 NA value

• x contains only a mix of whole numbers and/or NA values. If any values are not whole numbers then we can return FALSE even with the presence of NA values.

If x is not numeric then is_whole_number() always returns FALSE.

Value

TRUE, FALSE, or NA (see Details)

cheapr documentation built on Nov. 28, 2025, 5:06 p.m.