Rf_ScalarLogical: Rf_ScalarLogical

In ramiromagno/c3po: From C to R and back again

Description

\Sexpr[results=rd, stage=render]{c3po:::badge('fnp')} \Sexpr[results=rd, stage=render]{c3po:::badge('c2r')} \Sexpr[results=rd, stage=render]{c3po:::badge('prot')}

Converts an int x to a SEXP object that represents an R length one logical vector. The mapping from C integers to R's logical is:

• If x is NA_LOGICAL, then return value is NA (R_LogicalNAValue)

• If x is 0, then return value is FALSE (R_FalseValue)

• If x is any other value, then the return value is TRUE (R_TrueValue)

Arguments

x	an int value.

Value

A SEXP object, namely a length one logical vector.

Declaration

SEXP Rf_ScalarLogical(int x);

In Rinternals.h.

Definition

INLINE_FUN SEXP ScalarLogical(int x)
{
  extern SEXP R_LogicalNAValue, R_TrueValue, R_FalseValue;
  if (x == NA_LOGICAL) return R_LogicalNAValue;
  else if (x != 0) return R_TrueValue;
  else return R_FalseValue;
}

In Rinlinedfuns.h.

Examples

# Convert a C int number as an R length one logical vector with TRUE
true <- inline::cfunction(NULL,
 ' int x = 2;
   SEXP y;
   y = PROTECT(Rf_ScalarLogical(x));
   UNPROTECT(1);
   return y;
 ')
true()

# Convert a C int number as an R length one logical vector with FALSE
false <- inline::cfunction(NULL,
 ' int x = 0;
   SEXP y;
   y = PROTECT(Rf_ScalarLogical(x));
   UNPROTECT(1);
   return y;
 ')
false()

# Convert a C int number as an R length one logical vector with NA
na_logical <- inline::cfunction(NULL,
 ' int x = NA_LOGICAL;
   SEXP y;
   y = PROTECT(Rf_ScalarLogical(x));
   UNPROTECT(1);
   return y;
 ')
na_logical()

ramiromagno/c3po documentation built on Jan. 5, 2021, 8:01 p.m.