Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifications to class availability section #191

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions source/class-availability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,25 @@
Class availability
******************

In SYCL some SYCL runtime classes are available to
the SYCL application, some are available within a
SYCL kernel function and some are available on both
and can be passed as arguments to a SYCL kernel function.
In SYCL some SYCL runtime classes are available to the SYCL application, some
are available within a SYCL kernel function and some are available on both and
can be passed as arguments to a SYCL kernel function.

Each of the following SYCL runtime classes must be
available to the host application: :ref:`buffer`,
``sycl::buffer_allocator``, :ref:`context`, :ref:`device`,
:ref:`device_image`, :ref:`event`, `exception`, :ref:`handler`,
:ref:`host_accessor`, :ref:`host_sampled_image_accessor`,
:ref:`host_unsampled_image_accessor`, :ref:`id`, ``sycl::image_allocator``,
:ref:`kernel`, ``sycl::kernel_id``, `marray`, `kernel_bundle`,
Each of the following SYCL runtime classes must be available to the host
application: :ref:`buffer`, :ref:`buffer_allocator`, :ref:`context`,
:ref:`device`, :ref:`device_image`, :ref:`event`, :ref:`exception`,
:ref:`handler`, :ref:`host_accessor`, :ref:`host_sampled_image_accessor`,
:ref:`host_unsampled_image_accessor`, :ref:`id`, :ref:`image_allocator`,
:ref:`kernel`, :ref:`kernel_id`, :ref:`marray`, `kernel_bundle`,
:ref:`nd_range`, :ref:`platform`, :ref:`queue`, :ref:`range`,
:ref:`sampled_image`, :ref:`image_sampler`, :ref:`stream`,
:ref:`unsampled_image` and `vec`.
:ref:`unsampled_image` and :ref:`vec`.

Each of the following SYCL runtime classes must be available
within a SYCL kernel function: :ref:`command-accessor`, :ref:`atomic_ref`,
``sycl::device_event``, :ref:`group`, :ref:`h_item`, :ref:`id`, :ref:`item`,
:ref:`local_accessor`, `marray`, :ref:`multi_ptr`, :ref:`nd_item`,
:ref:`range`, `reducer`, :ref:`sampled_image_accessor`, :ref:`stream`,
:ref:`sub_group`, :ref:`unsampled_image_accessor` and `vec`.
Each of the following SYCL runtime classes must be available within a SYCL
kernel function: :ref:`command-accessor`, :ref:`atomic_ref`,
:ref:`device_event`, :ref:`group`, :ref:`h_item`, :ref:`id`, :ref:`item`,
:ref:`local_accessor`, :ref:`marray`, :ref:`multi_ptr`, :ref:`nd_item`,
:ref:`range`, :ref:`reducer`, :ref:`sampled_image_accessor`, :ref:`stream`,
:ref:`sub_group`, :ref:`unsampled_image_accessor` and :ref:`vec`.

.. seealso:: |SYCL_SPEC_CLASS_AVLBL|
23 changes: 23 additions & 0 deletions source/iface/buffer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,29 @@
Buffers
*******

.. _buffer_allocator:

==========================
``sycl::buffer_allocator``
==========================

::

template <typename T>
class buffer_allocator;

.. rubric:: Template parameters

================ ==========
``T`` Type of data in to be allocated.
================ ==========

The ``sycl::buffer_allocator`` class defines the default allocator that will be
used by a ``sycl::buffer`` when one is not provided by the user.
The ``sycl::buffer_allocator`` class meets the C++ named requirement Allocator.
A ``sycl::buffer`` of data type ``const T`` will use ``sycl::buffer_allocator``
by default.

.. _buffer:

================
Expand Down
2 changes: 2 additions & 0 deletions source/iface/exception.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
Exceptions
**********

.. _exception:

===================
``sycl::exception``
===================
Expand Down
14 changes: 14 additions & 0 deletions source/iface/image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@ provide the :ref:`common-reference`.

.. seealso:: |SYCL_SPEC_IMAGE|

.. _image_allocator:

==========================
``sycl::image_allocator``
==========================

::

class image_allocator;

The ``sycl::image_allocator`` class defines the default allocator that will be
used by a ``sycl::unsampled_buffer`` or ``sycl::sampled_buffer`` when one is not
provided by the user. The ``sycl::image_allocator`` allocates in elements of
``std::byte``.

.. _unsampled_image:

Expand Down
2 changes: 2 additions & 0 deletions source/iface/reduction-variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,8 @@ Constructors of the ``reduction property`` classes

Constructs an initialize_to_identity property instance.

.. _reducer:

``reducer class``
=================

Expand Down
Loading