Skip to contents

Define a list of user-defined options for rkeops package

Source: R/rkeops_options.R
def_rkeops_options.Rd

rkeops user-defined operators requires specific options to control their behavior at runtime (precision, verbosity, use of GPU, debug flag).

The function def_rkeops_options() returns a list with default (or specified) values for the corresponding options (see Details).

Usage

def_rkeops_options(
  backend = "CPU",
  device_id = -1,
  precision = "float32",
  verbosity = FALSE,
  debug = FALSE
)

Arguments

backend

string character, "CPU" for CPU computing and "GPU" for GPU computing. Default value is "CPU".

device_id

integer value corresponding to GPU id used for computation (when using GPU computing). Default

precision

string, character, precision for floating point computations ("float32" for 32bits float or "float64" for 64bits float/double precision). Default value is "float32".

verbosity

TRUE-FALSE or 1-0 indicator (boolean) for verbosity level. Default value is 0.

debug

TRUE-FALSE or 1-0 indicator (boolean) regarding compilation debugging flag. 1 means that user-defined operators will be compiled with a debug flag, and 0 means no debug flag. Default value is 0. DEPRECATED.

Value

a list (of class rkeops_options) with the following containing named values corresponding to the function input parameters.

Details

The aforementioned options correspond to the input parameters.

Note: Default options are set up when loading rkeops. To reset rkeops options to default or configure a particular option, you should use the function set_rkeops_options().

Some helper functions are available to enable some options, see rkeops_use_float32(), rkeops_use_float64(), rkeops_use_cpu(), rkeops_use_gpu(), rkeops_enable_verbosity(), rkeops_disable_verbosity().

Important: GPU computing requires a Nvidia GPU and CUDA drivers. It is recommended to use default GPU (i.e. device_id = -1 or 0) and manage GPU assignment outside R by setting the environment variable CUDA_VISIBLE_DEVICES.

See also

rkeops_use_float32(), rkeops_use_float64(), rkeops_use_cpu(), rkeops_use_gpu(), rkeops_enable_verbosity(), rkeops_disable_verbosity()

Author

Ghislain Durif