R/03-checks.r

In fml-fam/fmlr: Fused Matrix Library for R

check_class_consistency = function(...)
{
  l = list(...)
  if (length(l) < 2)
    return(invisible(TRUE))
  
  fmlr_is_funs = c(is_cpumat, is_cpuvec, is_gpuvec, is_gpumat)
  for (fun in fmlr_is_funs)
  {
    test = sapply(l, fun)
    if (any(test))
    {
      if (all(test))
        return(invisible(TRUE))
      else
        stop("inconsistent object usage: can not mix backends")
    }
  }
}



check_backend_consistency = function(...)
{
  l = list(...)
  if (length(l) < 2)
    return(invisible(TRUE))
  
  fmlr_backend_funs = c(is_cpu, is_gpu, is_mpi)
  for (fun in fmlr_backend_funs)
  {
    test_fun = sapply(l, fun)
    if (any(test_fun))
    {
      if (all(test_fun))
        return(invisible(TRUE))
      else
      {
        test_mpimat = sapply(l, is_mpi)
        test_cpuvec = sapply(l, is_cpuvec)
        if (any(test_mpimat) && any(test_cpuvec))
        {
          if (all(pmax(test_mpimat, test_cpuvec)))
            return(invisible(TRUE))
          else
            stop("inconsistent object usage: can not mix backends")
        }
      }
    }
  }
}



check_type_consistency = function(...)
{
  l = list(...)
  if (length(l) < 2)
    return(invisible(TRUE))
  
  gt = function(x) x$get_type()
  test = sapply(l, gt)
  
  if (sum(diff(test)) == 0)
    return(invisible(TRUE))
  else
    stop("inconsistent type usage: can not mix fundamental types")
}



check_inputs = function(ret, ..., check_class=TRUE)
{
  if (!is.null(ret))
  {
    if (check_class)
      check_class_consistency(ret, ...)
    else
      check_backend_consistency(ret, ...)
    
    check_type_consistency(ret, ...)
    invisiret = TRUE
  }
  else
  {
    if (check_class)
      check_class_consistency(...)
    else
      check_backend_consistency(ret, ...)
    
    check_type_consistency(...)
    invisiret = FALSE
  }
  
  invisiret
}



check_is_card = function(x)
{
  if (!is_card(x) || !isTRUE(x$valid_card()))
    stop("invalid card object")
  
  invisible(TRUE)
}



check_is_grid = function(x)
{
  if (!is_grid(x) || !isTRUE(x$valid_grid()))
    stop("invalid grid object")
  
  invisible(TRUE)
}



check_is_mat = function(x)
{
  if (!is_mat(x))
  {
    nm = deparse(substitute(x))
    stop(paste0("argument '", nm, "' must be a matrix type"), call.=FALSE)
  }
  
  invisible(TRUE)
}



check_is_vec = function(x)
{
  if (!is_vec(x))
  {
    nm = deparse(substitute(x))
    stop(paste0("argument '", nm, "' must be a vector type"), call.=FALSE)
  }
  
  invisible(TRUE)
}



# ------------------------------------------------------------------------------
# reactor
# ------------------------------------------------------------------------------

is.badval = function(x)
{
  is.na(x) || is.nan(x) || is.infinite(x)
}

is.inty = function(x)
{
  abs(x - round(x)) < 1e-10
}

is.zero = function(x)
{
  abs(x) < 1e-10
}

is.negative = function(x)
{
  x < 0
}

is.annoying = function(x)
{
  length(x) != 1 || is.badval(x)
}



check_is_integer = function(x)
{
  x = as.integer(x)
  if (is.annoying(x) || !is.inty(x))
  {
    nm = deparse(substitute(x))
    stop(paste0("argument '", nm, "' must be a natural number (0 or positive integer)"), call.=FALSE)
  }
  
  x
}

check_is_natnum = function(x)
{
  x = as.integer(x)
  if (is.annoying(x) || !is.inty(x) || is.negative(x))
  {
    nm = deparse(substitute(x))
    stop(paste0("argument '", nm, "' must be a natural number (0 or positive integer)"), call.=FALSE)
  }
  
  x
}

check_is_number = function(x)
{
  x = as.double(x)
  if (is.annoying(x))
  {
    nm = deparse(substitute(x))
    stop(paste0("argument '", nm, "' must be a natural number (0 or positive integer)"), call.=FALSE)
  }
  
  x
}