.. index:: pair: group; Device selection
.. _doxid-d8/d27/group___device_selectors:

Device selection
================

.. toctree::
	:hidden:

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// global functions

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	:ref:`DPCTLAcceleratorSelector_Create<doxid-d8/d27/group___device_selectors_1gaa8a810bcbfd1c1f74d44b2da6a50ef3f>`(void);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	:ref:`DPCTLCPUSelector_Create<doxid-d8/d27/group___device_selectors_1ga977605ab08808729951c6c33ef22df52>`(void);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	:ref:`DPCTLDefaultSelector_Create<doxid-d8/d27/group___device_selectors_1gadf9585e3b7e81b40abc15c843ba99aa8>`(void);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
	:ref:`DPCTLDeviceSelector_Delete<doxid-d8/d27/group___device_selectors_1ga30678acd2383c56d7eb78bf99b7bcf7c>`(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>` DSRef);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` int
	:ref:`DPCTLDeviceSelector_Score<doxid-d8/d27/group___device_selectors_1gab3f9bab0a2fcfeaf7858d264cca1253f>`(
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>` DSRef,
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef
		);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	:ref:`DPCTLFilterSelector_Create<doxid-d8/d27/group___device_selectors_1ga1cfad5b95c7793766cf863378cdccf3d>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const char* filter_str);

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	:ref:`DPCTLGPUSelector_Create<doxid-d8/d27/group___device_selectors_1ga1dabb6a4adf35a193d6d05240d8ed534>`(void);

.. _details-d8/d27/group___device_selectors:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Global Functions
----------------

.. index:: pair: function; DPCTLAcceleratorSelector_Create
.. _doxid-d8/d27/group___device_selectors_1gaa8a810bcbfd1c1f74d44b2da6a50ef3f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	DPCTLAcceleratorSelector_Create(void)

Returns an opaque wrapper for sycl::accelerator_selector object.



.. rubric:: Returns:

An opaque pointer to a sycl::accelerator_selector object.

.. index:: pair: function; DPCTLCPUSelector_Create
.. _doxid-d8/d27/group___device_selectors_1ga977605ab08808729951c6c33ef22df52:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	DPCTLCPUSelector_Create(void)

Returns an opaque wrapper for sycl::cpu_selector object.



.. rubric:: Returns:

An opaque pointer to a sycl::cpu_selector object.

.. index:: pair: function; DPCTLDefaultSelector_Create
.. _doxid-d8/d27/group___device_selectors_1gadf9585e3b7e81b40abc15c843ba99aa8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	DPCTLDefaultSelector_Create(void)

Returns an opaque wrapper for sycl::default_selector object.



.. rubric:: Returns:

An opaque pointer to a sycl::default_selector object.

.. index:: pair: function; DPCTLDeviceSelector_Delete
.. _doxid-d8/d27/group___device_selectors_1ga30678acd2383c56d7eb78bf99b7bcf7c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
	DPCTLDeviceSelector_Delete(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>` DSRef)

Deletes the DPCTLSyclDeviceSelectorRef after casting it to a sycl::device_selector.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DSRef

		- An opaque DPCTLSyclDeviceSelectorRef pointer that would be freed.

.. index:: pair: function; DPCTLDeviceSelector_Score
.. _doxid-d8/d27/group___device_selectors_1gab3f9bab0a2fcfeaf7858d264cca1253f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` int
	DPCTLDeviceSelector_Score(
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>` DSRef,
		:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef
		)

Scores the device specified by DRef by device selector specified by DSRef.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- DSRef

		- An opaque DPCTLSyclDeviceSelectorRef pointer.

	*
		- DRef

		- An opaque DPCTLSyclDeviceRef pointer.



.. rubric:: Returns:

A integer score. The negative value indicates select rejected the device.

.. index:: pair: function; DPCTLFilterSelector_Create
.. _doxid-d8/d27/group___device_selectors_1ga1cfad5b95c7793766cf863378cdccf3d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	DPCTLFilterSelector_Create(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const char* filter_str)

Returns an opaque wrapper for sycl::ext::oneapi::filter_selector object based on the passed in filter string.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- filter_str

		- A C string providing a filter based on which to create a device selector.



.. rubric:: Returns:

An opaque pointer to a sycl::ext::oneapi::filter_selector object.

.. index:: pair: function; DPCTLGPUSelector_Create
.. _doxid-d8/d27/group___device_selectors_1ga1dabb6a4adf35a193d6d05240d8ed534:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclDeviceSelectorRef<doxid-df/d57/dpctl__sycl__types_8h_1a50a1c6c98f4ca4a27a88e53a7f3eeb83>`
	DPCTLGPUSelector_Create(void)

Returns an opaque wrapper for dpctl_gpu_selector object.



.. rubric:: Returns:

An opaque pointer to a dpctl_gpu_selector object.