check_scalar_integer {TractorTsbox} | R Documentation |
Vérifie la conformité d'un entier scalaire
Description
Vérifie la conformité d'un entier scalaire
Usage
check_scalar_integer(x, warn = TRUE)
assert_scalar_integer(
x,
add = NULL,
.var.name = checkmate::vname(x),
warn = TRUE
)
Arguments
x |
un entier relatif (positif, négatif ou nul) |
warn |
un booleen |
add |
Collection pour stocker les messages d'erreurs (Default is NULL) |
.var.name |
Nom de l'objet à vérifier pour afficher dans les messages |
Details
On vérifie que l'objet x
en entrée est bien un entier.
Cette fonction s'appuie essentiellement sur la fonction
checkmate::assert_int
.
Il y a néanmoins une petite subtilité : on vérifie si l'objet x
est de
type double ou integer. Si l'objet est de type double (et non integer), la
fonction retournera aussi un warning.
Dans le premier cas, on affichera un warning et on corrigera l'objet au
format integer pour les traitements ultérieurs. En sortie, x
est retourné
de manière invisible.
Si l'argument warn
vaut FALSE
, alors la fonction ne retournera pas de
warning lors de l'évaluation.
Selon le préfixe de la fonction :
si le check réussi :
la fonction
assert_scalar_integer
retourne l'objetx
de manière invisible;la fonction
check_scalar_integer
retourne le booléenTRUE
.
si le check échoue :
la fonction
assert_scalar_integer
retourne un message d'erreur;la fonction
check_scalar_integer
retourne une chaîne de caractère signalant le problème.
Value
En sortie la fonction retourne l'objet x
de manière invisible ou
une erreur.
See Also
check_scalar_natural()
, assert_scalar_natural()
Examples
assert_scalar_integer(1L)
assert_scalar_integer(100L)
assert_scalar_integer(-4L)
assert_scalar_integer(0L)
check_scalar_integer(1L)
check_scalar_integer(100L)
check_scalar_integer(-4L)
check_scalar_integer(0L)
# Avec des erreurs,
check_scalar_integer(Inf)
check_scalar_integer(1:10)
check_scalar_integer(pi)
check_scalar_integer(2.)