test_r_binding: R binding test
In mlpack: 'Rcpp' Integration for the 'mlpack' Library

test_r_binding

R Documentation

R binding test

Description

A simple program to test R binding functionality.

Usage

test_r_binding(
  double_in,
  int_in,
  string_in,
  build_model = FALSE,
  col_in = NA,
  flag1 = FALSE,
  flag2 = FALSE,
  matrix_and_info_in = NA,
  matrix_in = NA,
  model_in = NA,
  row_in = NA,
  str_vector_in = NA,
  tmatrix_in = NA,
  ucol_in = NA,
  umatrix_in = NA,
  urow_in = NA,
  vector_in = NA,
  verbose = getOption("mlpack.verbose", FALSE)
)

Arguments

`double_in`	Input double, must be 4.0 (numeric).
`int_in`	Input int, must be 12 (integer).
`string_in`	Input string, must be 'hello' (character).
`build_model`	If true, a model will be returned. Default value "FALSE" (logical).
`col_in`	Input column (numeric column).
`flag1`	Input flag, must be specified. Default value "FALSE" (logical).
`flag2`	Input flag, must not be specified. Default value "FALSE" (logical).
`matrix_and_info_in`	Input matrix and info (numeric matrix/data.frame with info).
`matrix_in`	Input matrix (numeric matrix).
`model_in`	Input model (GaussianKernel).
`row_in`	Input row (numeric row).
`str_vector_in`	Input vector of strings (character vector).
`tmatrix_in`	Input (transposed) matrix (numeric matrix).
`ucol_in`	Input unsigned column (integer column).
`umatrix_in`	Input unsigned matrix (integer matrix).
`urow_in`	Input unsigned row (integer row).
`vector_in`	Input vector of numbers (integer vector).
`verbose`	Display informational messages and the full list of parameters and timers at the end of execution. Default value "getOption("mlpack.verbose", FALSE)" (logical).

Details

A simple program to test R binding functionality. You can build mlpack with the BUILD_TESTS option set to off, and this binding will no longer be built.

Value

A list with several components:

`col_out`	Output column. 2x input colum (numeric column).
`double_out`	Output double, will be 5.0. Default value "0" (numeric).
`int_out`	Output int, will be 13. Default value "0" (integer).
`matrix_and_info_out`	Output matrix and info; all numeric elements multiplied by 3 (numeric matrix).
`matrix_out`	Output matrix (numeric matrix).
`model_bw_out`	The bandwidth of the model. Default value "0" (numeric).
`model_out`	Output model, with twice the bandwidth (GaussianKernel).
`row_out`	Output row. 2x input row (numeric row).
`str_vector_out`	Output string vector (character vector).
`string_out`	Output string, will be 'hello2'. Default value "" (character).
`ucol_out`	Output unsigned column. 2x input column (integer column).
`umatrix_out`	Output unsigned matrix (integer matrix).
`urow_out`	Output unsigned row. 2x input row (integer row).
`vector_out`	Output vector (integer vector).