Skip to content

Commit 30a3a86

Browse files
committed
Add note that get_devices(host) returns nothing
Although device_type::host still exists, the concept of a "host device" does not exist. Calling get_devices() with device_type::host should not do anything.
1 parent 8b9ea89 commit 30a3a86

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

adoc/chapters/programming_interface.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1129,6 +1129,10 @@ _Returns:_ A [code]#std::vector# containing all of the <<root-device,root
11291129
devices>> associated with this platform which have the device type specified by
11301130
[code]#type#.
11311131

1132+
{note}Since the concept of a "host device" does not exist in SYCL 2020, if
1133+
[code]#type# is [code]#info::device_type::host# this function will always return
1134+
an empty vector.{endnote}
1135+
11321136
_Remarks_: If [code]#type# is [code]#info::device_type::all#, the
11331137
[code]#std::vector# contains all root devices in this platform.
11341138
If [code]#type# is [code]#info::device_type::automatic# and the platform is not
@@ -1851,6 +1855,10 @@ _Returns:_ A [code]#std::vector# containing all the <<root-device, root
18511855
devices>> from all <<backend, SYCL backends>> available in the system which have
18521856
the device type [code]#type#.
18531857

1858+
{note}Since the concept of a "host device" does not exist in SYCL 2020, if
1859+
[code]#type# is [code]#info::device_type::host# this function will always return
1860+
an empty vector.{endnote}
1861+
18541862
_Remarks_: If [code]#type# is [code]#info::device_type::all#, the
18551863
[code]#std::vector# contains all root devices in the system.
18561864
If [code]#type# is [code]#info::device_type::automatic#, the [code]#std::vector#

0 commit comments

Comments
 (0)