get_rkeops_option: Get the current value of a specific compile or runtime...

In rkeops: Kernel Operations on GPU or CPU, with Autodiff, without Memory Overflows

Description

The function get_rkeops_option returns the current value of a specific rkeops option (in R global options scope) provided as input.

Usage

get_rkeops_option(option)

Arguments

option

string, name of the options to set up (see Details).

Details

rkeops global options includes two lists defining options used at compilation of user-defined operators or at runtime. These two list contains specific informations (see compile_options() and runtime_options() respectively, in particular for default values).

With the function get_rkeops_option, you get the value of a specific rkeops option among:

• rkeops compile options: rkeops_dir(not recommended),build_dir, src_dir(not recommended),precision, verbosity, use_cuda_if_possible, col_major(not recommended),debug'

• rkeops runtime options: tagCpuGpu, tag1D2D, tagHostDevice, device_id These options are set with the functions set_rkeops_options() and set_rkeops_option(). To know which values are allowed for which options, you can check compile_options() and runtime_options().

Value

the value of the requested option (see Details).

Author(s)

Ghislain Durif

See Also

get_rkeops_options(), compile_options(), runtime_options(), set_rkeops_options(), set_rkeops_option()

Examples

library(rkeops)
# to get the GPU id used for computations
get_rkeops_option("device_id")

rkeops documentation built on Feb. 17, 2021, 5:08 p.m.