info Please note that this product is now discontinued and product support has ceased. For more information, please read the blog

menu_bookReference

history2.11.0
  1. Classes
    1. N
      cl
      1. N
        sycl
        1. S
          hash< cl::sycl::accessor< elemT, kDims, kMode, kTarget, isPlaceholder > >
          1. N
            info
            1. N
              property
              1. C
                device_selector
                1. C
                  accessor< elemT, 0, kMode, access::target::local, access::placeholder::false_t >
                  1. C
                    accessor< elemT, kDims, kMode, access::target::host_image, access::placeholder::false_t >
                    1. C
                      accessor< elemT, kDims, kMode, access::target::image, access::placeholder::false_t >
                      1. C
                        accessor< elemT, kDims, kMode, access::target::local, access::placeholder::false_t >
                        1. C
                          accessor_error
                          1. S
                            atomic
                            1. C
                              backend_traits< backend::opencl >
                              1. C
                                buffer< const T, dims, AllocatorT >
                                1. C
                                  context
                                  1. C
                                    default_selector
                                    1. C
                                      device_error
                                      1. S
                                        device_type
                                        1. C
                                          event
                                          1. C
                                            exception
                                            1. C
                                              feature_not_supported
                                              1. C
                                                group
                                                1. C
                                                  handler
                                                  1. C
                                                    id
                                                    1. S
                                                      info_convert< cl_context *, context >
                                                      1. S
                                                        info_convert< cl_platform_id *, platform >
                                                        1. C
                                                          intel_selector
                                                          1. C
                                                            invalid_parameter_error
                                                            1. C
                                                              kernel
                                                              1. C
                                                                link_program_error
                                                                1. C
                                                                  multi_ptr
                                                                  1. C
                                                                    multi_ptr< void, asp >
                                                                    1. C
                                                                      nd_range
                                                                      1. C
                                                                        opencl_selector
                                                                        1. C
                                                                          platform_error
                                                                          1. C
                                                                            private_memory
                                                                            1. C
                                                                              profiling_error
                                                                              1. C
                                                                                property_list
                                                                                1. C
                                                                                  range
                                                                                  1. C
                                                                                    sampler
                                                                                    1. S
                                                                                      stream_vec
                                                                                      1. S
                                                                                        stream_vec< 2, true, elementT, kDimensions >
                                                                                        1. S
                                                                                          stream_vec< 4, true, elementT, kDimensions >
                                                                                          1. C
                                                                                            swizzled_vec
                                                                                          2. S
                                                                                            hash< cl::sycl::context >
                                                                                            1. S
                                                                                              hash< cl::sycl::event >
                                                                                              1. S
                                                                                                hash< cl::sycl::kernel >
                                                                                                1. S
                                                                                                  hash< cl::sycl::program >
                                                                                                  1. S
                                                                                                    hash< cl::sycl::sampler >
                                                                                                  2. N
                                                                                                    codeplay
                                                                                                    1. N
                                                                                                      profiling
                                                                                                      1. N
                                                                                                        property
                                                                                                        1. C
                                                                                                          handler
                                                                                                          1. C
                                                                                                            interop_handle
                                                                                                            1. S
                                                                                                              maximum
                                                                                                              1. S
                                                                                                                maximum< void >
                                                                                                                1. S
                                                                                                                  minimum< void >
                                                                                                                  1. C
                                                                                                                    no_init_impl
                                                                                                                  2. C
                                                                                                                    profiling_zone
                                                                                                                    1. C
                                                                                                                      host_access
                                                                                                                    2. N
                                                                                                                      buffer
                                                                                                                      1. C
                                                                                                                        use_onchip_memory
                                                                                                                        1. C
                                                                                                                          host_handler
                                                                                                                          1. S
                                                                                                                            rebind
                                                                                                                            1. C
                                                                                                                              context_bound
                                                                                                                              1. C
                                                                                                                                use_mutex
                                                                                                                                1. C
                                                                                                                                  enable_profiling
                                                                                                                                2. N
                                                                                                                                  experimental
                                                                                                                                  1. S
                                                                                                                                    sub_group
                                                                                                                                    1. S
                                                                                                                                      minimum
                                                                                                                                      1. C
                                                                                                                                        usm_allocator
                                                                                                                                        1. N
                                                                                                                                          ext
                                                                                                                                          1. S
                                                                                                                                            param_traits
                                                                                                                                            1. N
                                                                                                                                              buffer
                                                                                                                                              1. C
                                                                                                                                                use_host_ptr
                                                                                                                                                1. N
                                                                                                                                                  queue
                                                                                                                                                  1. C
                                                                                                                                                    in_order_impl
                                                                                                                                                    1. C
                                                                                                                                                      accelerator_selector
                                                                                                                                                      1. C
                                                                                                                                                        accessor
                                                                                                                                                        1. C
                                                                                                                                                          accessor< elemT, kDims, kMode, access::target::host_buffer, access::placeholder::false_t >
                                                                                                                                                          1. C
                                                                                                                                                            accessor< elemT, kDims, kMode, access::target::host_task, IsPlaceholder >
                                                                                                                                                            1. C
                                                                                                                                                              accessor< elemT, kDims, kMode, access::target::image_array, access::placeholder::false_t >
                                                                                                                                                              1. C
                                                                                                                                                                accessor< elemT, kDims, kMode, access::target::subgroup_local, access::placeholder::false_t >
                                                                                                                                                                1. C
                                                                                                                                                                  amd_selector
                                                                                                                                                                  1. C
                                                                                                                                                                    backend_traits
                                                                                                                                                                    1. C
                                                                                                                                                                      buffer
                                                                                                                                                                      1. C
                                                                                                                                                                        compile_program_error
                                                                                                                                                                        1. C
                                                                                                                                                                          cpu_selector
                                                                                                                                                                          1. C
                                                                                                                                                                            device
                                                                                                                                                                            1. C
                                                                                                                                                                              device_event
                                                                                                                                                                              1. S
                                                                                                                                                                                elem
                                                                                                                                                                                1. C
                                                                                                                                                                                  event_error
                                                                                                                                                                                  1. C
                                                                                                                                                                                    exception_list
                                                                                                                                                                                    1. C
                                                                                                                                                                                      gpu_selector
                                                                                                                                                                                      1. C
                                                                                                                                                                                        h_item
                                                                                                                                                                                        1. C
                                                                                                                                                                                          host_selector
                                                                                                                                                                                          1. C
                                                                                                                                                                                            image
                                                                                                                                                                                            1. S
                                                                                                                                                                                              info_convert< cl_device_id *, device >
                                                                                                                                                                                              1. S
                                                                                                                                                                                                info_convert< size_t *, range< 3 > >
                                                                                                                                                                                                1. C
                                                                                                                                                                                                  invalid_object_error
                                                                                                                                                                                                  1. C
                                                                                                                                                                                                    item
                                                                                                                                                                                                    1. C
                                                                                                                                                                                                      kernel_error
                                                                                                                                                                                                      1. C
                                                                                                                                                                                                        memory_allocation_error
                                                                                                                                                                                                        1. C
                                                                                                                                                                                                          multi_ptr< const void, asp >
                                                                                                                                                                                                          1. C
                                                                                                                                                                                                            nd_item
                                                                                                                                                                                                            1. C
                                                                                                                                                                                                              nd_range_error
                                                                                                                                                                                                              1. C
                                                                                                                                                                                                                platform
                                                                                                                                                                                                                1. C
                                                                                                                                                                                                                  precision_manipulator
                                                                                                                                                                                                                  1. C
                                                                                                                                                                                                                    handler::parallel_for_work_group
                                                                                                                                                                                                                    1. C
                                                                                                                                                                                                                      program
                                                                                                                                                                                                                      1. C
                                                                                                                                                                                                                        queue
                                                                                                                                                                                                                        1. C
                                                                                                                                                                                                                          runtime_error
                                                                                                                                                                                                                          1. C
                                                                                                                                                                                                                            stream
                                                                                                                                                                                                                            1. S
                                                                                                                                                                                                                              stream_vec< 16, true, elementT, kDimensions >
                                                                                                                                                                                                                              1. S
                                                                                                                                                                                                                                stream_vec< 3, true, elementT, kDimensions >
                                                                                                                                                                                                                                1. S
                                                                                                                                                                                                                                  stream_vec< 8, true, elementT, kDimensions >
                                                                                                                                                                                                                                  1. C
                                                                                                                                                                                                                                    vec
                                                                                                                                                                                                                                    1. S
                                                                                                                                                                                                                                      hash< cl::sycl::buffer< T, dimensions, AllocatorT > >
                                                                                                                                                                                                                                      1. S
                                                                                                                                                                                                                                        hash< cl::sycl::device >
                                                                                                                                                                                                                                        1. S
                                                                                                                                                                                                                                          hash< cl::sycl::image< kDimensions, AllocatorT > >
                                                                                                                                                                                                                                          1. S
                                                                                                                                                                                                                                            hash< cl::sycl::platform >
                                                                                                                                                                                                                                            1. S
                                                                                                                                                                                                                                              hash< cl::sycl::queue >
                                                                                                                                                                                                                                              1. S
                                                                                                                                                                                                                                                hash< cl::sycl::stream >

                                                                                                                                                                                                                                              cl::sycl::item< dimensions, with_offset > Class Template Reference

                                                                                                                                                                                                                                              The cl::sycl::item object is a container for all information about a work item. More...

                                                                                                                                                                                                                                              #include <base.h>

                                                                                                                                                                                                                                              Inheritance diagram for cl::sycl::item< dimensions, with_offset >:

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               item (const item &rhs)=default
                                                                                                                                                                                                                                               Copy constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               item (const detail::item_base &itemBase)
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_range (int dimension) const
                                                                                                                                                                                                                                               Gets the global range in a specified dimension if provided by a handler::parallel_for and gets the local range in a specified dimension if provided by a parallel_for_work_item. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< dimensions > get_range () const
                                                                                                                                                                                                                                               Get the global range of the enqueued kernel if provided by a handler::parallel_for. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(offset_t, with_offset) >
                                                                                                                                                                                                                                              id< dimensions > get_offset () const
                                                                                                                                                                                                                                               Get the invocation offset. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_id (int dimension) const
                                                                                                                                                                                                                                               Get the id for a specific dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              id< dimensions > get_id () const
                                                                                                                                                                                                                                               Get the id associated with this item for all dimensions. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<class sfinae = offset_t>
                                                                                                                                                                                                                                               operator detail::enable_if_t< has_no_offset< sfinae > ()
                                                                                                                                                                                                                                               Returns an item representing the same information as the object holds but also includes the offset set to 0. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               item () const
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

                                                                                                                                                                                                                                              bool operator== (const item &lhs, const item &rhs)
                                                                                                                                                                                                                                               Equality operator. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool operator!= (const item &lhs, const item &rhs)
                                                                                                                                                                                                                                               Non-equality operator. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              class cl::sycl::item< dimensions, with_offset >

                                                                                                                                                                                                                                              The cl::sycl::item object is a container for all information about a work item.

                                                                                                                                                                                                                                              The cl::sycl::item object is used within the handler::parallel_for and parallel_for_work_item functions. The cl::sycl::item object can return information about the local and global sizes of an enqueued nd_range as well as the local and global ids of the work item. item<dimensions> is a derived class of detail::item_base, which is a non-templated class implementing most of the functionality of cl::sycl::item<dimensions>.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              dimensionsNumber of dimensions of the item object
                                                                                                                                                                                                                                              with_offsetWhether the object contains an offset or not

                                                                                                                                                                                                                                              Definition at line 42 of file base.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ item() [1/3]

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              cl::sycl::item< dimensions, with_offset >::item ( const item< dimensions, with_offset > &  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Copy constructor.

                                                                                                                                                                                                                                              Create a copy of another item object.

                                                                                                                                                                                                                                              ◆ item() [2/3]

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              cl::sycl::item< dimensions, with_offset >::item ( const detail::item_base &  itemBase)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Definition at line 121 of file item.h.

                                                                                                                                                                                                                                              ◆ item() [3/3]

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              cl::sycl::item< dimensions, with_offset >::item ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Definition at line 188 of file item.h.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ get_id() [1/2]

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              size_t cl::sycl::item< dimensions, with_offset >::get_id ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get the id for a specific dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionof the id, in the range [0,2]
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the id for the specified dimension.

                                                                                                                                                                                                                                              Definition at line 171 of file item.h.

                                                                                                                                                                                                                                              ◆ get_id() [2/2]

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              id<dimensions> cl::sycl::item< dimensions, with_offset >::get_id ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get the id associated with this item for all dimensions.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The global id if the item is provided by a handler::parallel_for. The local id if the item is provided by a parallel_for_work_item.

                                                                                                                                                                                                                                              Definition at line 178 of file item.h.

                                                                                                                                                                                                                                              ◆ get_offset()

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(offset_t, with_offset) >
                                                                                                                                                                                                                                              id<dimensions> cl::sycl::item< dimensions, with_offset >::get_offset ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get the invocation offset.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly available if with_offset is true
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the offset used to invoke the kernel.

                                                                                                                                                                                                                                              Definition at line 163 of file item.h.

                                                                                                                                                                                                                                              ◆ get_range() [1/2]

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              size_t cl::sycl::item< dimensions, with_offset >::get_range ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Gets the global range in a specified dimension if provided by a handler::parallel_for and gets the local range in a specified dimension if provided by a parallel_for_work_item.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionThe dimension of the range to retrieve.
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The value of the global range in the dimension specified.

                                                                                                                                                                                                                                              Definition at line 147 of file item.h.

                                                                                                                                                                                                                                              ◆ get_range() [2/2]

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              range<dimensions> cl::sycl::item< dimensions, with_offset >::get_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get the global range of the enqueued kernel if provided by a handler::parallel_for.

                                                                                                                                                                                                                                              Get the local range if used if provided by a parallel_for_work_item.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the values of the global range for all dimensions.

                                                                                                                                                                                                                                              Definition at line 154 of file item.h.

                                                                                                                                                                                                                                              ◆ operator detail::enable_if_t< has_no_offset< sfinae >()

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              template<class sfinae = offset_t>
                                                                                                                                                                                                                                              cl::sycl::item< dimensions, with_offset >::operator detail::enable_if_t< has_no_offset< sfinae > ( )

                                                                                                                                                                                                                                              Returns an item representing the same information as the object holds but also includes the offset set to 0.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              sfinaeDummy type to signal that this conversion is only available if with_offset is false
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              This object with an offset added

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ operator!=

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              bool operator!= ( const item< dimensions, with_offset > &  lhs,
                                                                                                                                                                                                                                              const item< dimensions, with_offset > &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Non-equality operator.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rhsObject to compare to
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if at least one member variable not the same as the corresponding rhs member variable

                                                                                                                                                                                                                                              Definition at line 137 of file item.h.

                                                                                                                                                                                                                                              ◆ operator==

                                                                                                                                                                                                                                              template<int dimensions = 1, bool with_offset = true>
                                                                                                                                                                                                                                              bool operator== ( const item< dimensions, with_offset > &  lhs,
                                                                                                                                                                                                                                              const item< dimensions, with_offset > &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Equality operator.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rhsObject to compare to
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if all member variables are equal to rhs member variables

                                                                                                                                                                                                                                              Definition at line 128 of file item.h.

                                                                                                                                                                                                                                              The documentation for this class was generated from the following files:

                                                                                                                                                                                                                                              Select a Product

                                                                                                                                                                                                                                              Please select a product

                                                                                                                                                                                                                                              oneAPI

                                                                                                                                                                                                                                              oneAPI is a cross-industry, open, standards-based unified programming model that delivers a common developer experience across accelerator architecture - for faster application performance, more productivity, and greater innovation.

                                                                                                                                                                                                                                              Dark Mode
                                                                                                                                                                                                                                              brightness_2

                                                                                                                                                                                                                                              Dark Mode

                                                                                                                                                                                                                                              Light text on a dark background.

                                                                                                                                                                                                                                              Light Mode
                                                                                                                                                                                                                                              lightbulb_outline

                                                                                                                                                                                                                                              Light Mode

                                                                                                                                                                                                                                              Dark text on a light background.

                                                                                                                                                                                                                                              public

                                                                                                                                                                                                                                              Also,

                                                                                                                                                                                                                                              part of our network

                                                                                                                                                                                                                                              search
                                                                                                                                                                                                                                              No results found, please try another search term.
                                                                                                                                                                                                                                              sync
                                                                                                                                                                                                                                              Searching, Please Wait...

                                                                                                                                                                                                                                              Please type to begin searching or try these:


                                                                                                                                                                                                                                              • oneapi nvidia
                                                                                                                                                                                                                                              • cl::sycl
                                                                                                                                                                                                                                              • 2.5.0
                                                                                                                                                                                                                                              • download oneapi amd
                                                                                                                                                                                                                                              • getting started guide
                                                                                                                                                                                                                                              • construction kit
                                                                                                                                                                                                                                              Tip: Press 'enter' key to select first result.
                                                                                                                                                                                                                                              There was a problem searching, please try again later.