init_compute_deviceT_init_compute_deviceInitComputeDeviceInitComputeDevice (Operator)

Name

init_compute_deviceT_init_compute_deviceInitComputeDeviceInitComputeDevice — Initialize a compute device.

Signature

init_compute_device( : : DeviceHandle, Operators : )

Description

init_compute_deviceinit_compute_deviceInitComputeDeviceInitComputeDeviceInitComputeDevice initializes a compute device and prepares a list of operators given in OperatorsOperatorsOperatorsOperatorsoperators for the execution on this device. Further the device is activated for the current thread. If init_compute_deviceinit_compute_deviceInitComputeDeviceInitComputeDeviceInitComputeDevice is not called or operators other than those in OperatorsOperatorsOperatorsOperatorsoperators are used on the device, the initialization is performed on demand.

Use get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo to test if an operator qualifies for execution on the compute device.

Attention

Be aware that the execution time of init_compute_deviceinit_compute_deviceInitComputeDeviceInitComputeDeviceInitComputeDevice depends on the number of OperatorsOperatorsOperatorsOperatorsoperators and may last up to several seconds.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
Processed without parallelization.

Parameters

DeviceHandleDeviceHandleDeviceHandleDeviceHandledeviceHandle (input_control) compute_device → (handle)

Compute device handle.

OperatorsOperatorsOperatorsOperatorsoperators (input_control) string-array → (string)

List of operators to prepare.

Default value: 'all' "all" "all" "all" "all"

List of values: 'all'"all""all""all""all", 'derivate_gauss'"derivate_gauss""derivate_gauss""derivate_gauss""derivate_gauss", 'sobel_amp'"sobel_amp""sobel_amp""sobel_amp""sobel_amp"

Result

The operator init_compute_deviceinit_compute_deviceInitComputeDeviceInitComputeDeviceInitComputeDevice returns the value 2 (H_MSG_TRUE) if the initialization was successful. Otherwise an exception will be raised.

Possible Predecessors

query_available_compute_devicesquery_available_compute_devicesQueryAvailableComputeDevicesQueryAvailableComputeDevicesQueryAvailableComputeDevices, open_compute_deviceopen_compute_deviceOpenComputeDeviceOpenComputeDeviceOpenComputeDevice

Possible Successors

activate_compute_deviceactivate_compute_deviceActivateComputeDeviceActivateComputeDeviceActivateComputeDevice

Module

Foundation

Operators