Developer Functions for the mutatomic Class

The stopifnot_ma_safe2mutate() function checks if an atomic object is actually safe to mutate.
The .internal_set_ma() function sets an object to class 'mutatomic' by reference.

Usage

stopifnot_ma_safe2mutate(sym, envir, .abortcall)

address(x)

.internal_set_ma(x)

Arguments

sym

the symbol of the object; i.e. substitute(x).

envir

the environment where the object resides; i.e. parent.frame(n = 1).

.abortcall

environment where the error message is passed to.

x

atomic object

Value

Nothing. Only gives an error if the object is not safe to mutate.

Examples

testfun1 <- function(x) {
  .internal_set_ma(x)
}


x <- 1:10
is.mutatomic(x)
#> [1] FALSE

testfun1(x)
is.mutatomic(x) # FALSE, because it's ALTREP
#> [1] FALSE

x <- sample(1:10)
is.mutatomic(x)
#> [1] FALSE

testfun1(x)
is.mutatomic(x)
#> [1] TRUE
print(x)
#>  [1]  2  8 10  6  7  1  5  3  4  9
#> mutatomic 
#> typeof:  integer