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::h_item< dimensions > Class Template Reference

                                                                                                                                                                                                                                              Identifies an instance of a parallel_for_work_item function object executing at each point in a local range passed to a parallel_for_work_item call. More...

                                                                                                                                                                                                                                              #include <base.h>

                                                                                                                                                                                                                                              Inheritance diagram for cl::sycl::h_item< dimensions >:

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               h_item ()=delete
                                                                                                                                                                                                                                               Not user constructible. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              item< dimensions, false > get_global () const
                                                                                                                                                                                                                                               Retrieves the constituent global item representing the work-item's position in the global iteration space. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              item< dimensions, false > get_local () const
                                                                                                                                                                                                                                               Retrieves the constituent logical local item representing the work-item's position in the local iteration space as provided upon the invocation of parallel_for_work_item. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              item< dimensions, false > get_logical_local () const
                                                                                                                                                                                                                                               Retrieves the constituent logical local item representing the work-item's position in the local iteration space as provided upon the invocation of parallel_for_work_item. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              item< dimensions, false > get_physical_local () const
                                                                                                                                                                                                                                               Retrieves the constituent physical local item representing the work-item's position in the local iteration space as provided upon the invocation of parallel_for_work_group. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< dimensions > get_global_range () const
                                                                                                                                                                                                                                               Retrieves the range representing the sizes of the global iteration space. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_global_range (int dimension) const
                                                                                                                                                                                                                                               Retrieves the value of the global range for the specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              id< dimensions > get_global_id () const
                                                                                                                                                                                                                                               Retrieves the id representing the position of the item in the global iteration space. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_global_id (int dimension) const
                                                                                                                                                                                                                                               Retrieves the value of the global ID for the specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< dimensions > get_local_range () const
                                                                                                                                                                                                                                               Retrieves the range representing the sizes of the logical local iteration space. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_local_range (int dimension) const
                                                                                                                                                                                                                                               Retrieves the value of the logical local range for the specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              id< dimensions > get_local_id () const
                                                                                                                                                                                                                                               Retrieves the id representing the position of the item in the logical local iteration space. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_local_id (int dimension) const
                                                                                                                                                                                                                                               Retrieves the value of the logical local ID for the specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< dimensions > get_logical_local_range () const
                                                                                                                                                                                                                                               Retrieves the range representing the sizes of the logical local iteration space. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_logical_local_range (int dimension) const
                                                                                                                                                                                                                                               Retrieves the value of the logical local range for the specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              id< dimensions > get_logical_local_id () const
                                                                                                                                                                                                                                               Retrieves the id representing the position of the item in the logical local iteration space. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_logical_local_id (int dimension) const
                                                                                                                                                                                                                                               Retrieves the value of the logical local ID for the specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< dimensions > get_physical_local_range () const
                                                                                                                                                                                                                                               Retrieves the range representing the sizes of the physical local iteration space. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_physical_local_range (int dimension) const
                                                                                                                                                                                                                                               Retrieves the value of the physical local range for the specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              id< dimensions > get_physical_local_id () const
                                                                                                                                                                                                                                               Retrieves the id representing the position of the item in the physical local iteration space. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_physical_local_id (int dimension) const
                                                                                                                                                                                                                                               Retrieves the value of the physical local ID for the specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool is_equal (const h_item &rhs) const
                                                                                                                                                                                                                                               Helper function for calling operator==() More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

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

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              class cl::sycl::h_item< dimensions >

                                                                                                                                                                                                                                              Identifies an instance of a parallel_for_work_item function object executing at each point in a local range passed to a parallel_for_work_item call.

                                                                                                                                                                                                                                              It encapsulates enough information to identify the work-item's local and global items according to the information given to parallel_for_work_group (physical ids) as well as the work-item's logical local items in the flexible range. All returned item objects are offset-less.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              dimensionsNumber of dimensions of the h_item object

                                                                                                                                                                                                                                              Definition at line 48 of file base.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ h_item()

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              cl::sycl::h_item< dimensions >::h_item ( )
                                                                                                                                                                                                                                              		delete

                                                                                                                                                                                                                                              Not user constructible.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ get_global()

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              item<dimensions, false> cl::sycl::h_item< dimensions >::get_global ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the constituent global item representing the work-item's position in the global iteration space.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Item representing the global ID and range

                                                                                                                                                                                                                                              Definition at line 779 of file item.h.

                                                                                                                                                                                                                                              ◆ get_global_id() [1/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              id<dimensions> cl::sycl::h_item< dimensions >::get_global_id ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the id representing the position of the item in the global iteration space.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Global ID

                                                                                                                                                                                                                                              Definition at line 830 of file item.h.

                                                                                                                                                                                                                                              ◆ get_global_id() [2/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              size_t cl::sycl::h_item< dimensions >::get_global_id ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the value of the global ID for the specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionWhich value of the ID to retrieve
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Element of the global ID

                                                                                                                                                                                                                                              Definition at line 838 of file item.h.

                                                                                                                                                                                                                                              ◆ get_global_range() [1/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              range<dimensions> cl::sycl::h_item< dimensions >::get_global_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the range representing the sizes of the global iteration space.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Global range

                                                                                                                                                                                                                                              Definition at line 814 of file item.h.

                                                                                                                                                                                                                                              ◆ get_global_range() [2/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              size_t cl::sycl::h_item< dimensions >::get_global_range ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the value of the global range for the specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionWhich value of the range to retrieve
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Element of the global range

                                                                                                                                                                                                                                              Definition at line 822 of file item.h.

                                                                                                                                                                                                                                              ◆ get_local()

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              item<dimensions, false> cl::sycl::h_item< dimensions >::get_local ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the constituent logical local item representing the work-item's position in the local iteration space as provided upon the invocation of parallel_for_work_item.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Item representing the logical local ID and range

                                                                                                                                                                                                                                              Definition at line 788 of file item.h.

                                                                                                                                                                                                                                              ◆ get_local_id() [1/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              id<dimensions> cl::sycl::h_item< dimensions >::get_local_id ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the id representing the position of the item in the logical local iteration space.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Global ID

                                                                                                                                                                                                                                              Definition at line 863 of file item.h.

                                                                                                                                                                                                                                              ◆ get_local_id() [2/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              size_t cl::sycl::h_item< dimensions >::get_local_id ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the value of the logical local ID for the specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionWhich value of the ID to retrieve
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Element of the logical local ID

                                                                                                                                                                                                                                              Definition at line 872 of file item.h.

                                                                                                                                                                                                                                              ◆ get_local_range() [1/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              range<dimensions> cl::sycl::h_item< dimensions >::get_local_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the range representing the sizes of the logical local iteration space.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Global range

                                                                                                                                                                                                                                              Definition at line 846 of file item.h.

                                                                                                                                                                                                                                              ◆ get_local_range() [2/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              size_t cl::sycl::h_item< dimensions >::get_local_range ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the value of the logical local range for the specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionWhich value of the range to retrieve
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Element of the logical local range

                                                                                                                                                                                                                                              Definition at line 855 of file item.h.

                                                                                                                                                                                                                                              ◆ get_logical_local()

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              item<dimensions, false> cl::sycl::h_item< dimensions >::get_logical_local ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the constituent logical local item representing the work-item's position in the local iteration space as provided upon the invocation of parallel_for_work_item.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Item representing the logical local ID and range

                                                                                                                                                                                                                                              Definition at line 797 of file item.h.

                                                                                                                                                                                                                                              ◆ get_logical_local_id() [1/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              id<dimensions> cl::sycl::h_item< dimensions >::get_logical_local_id ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the id representing the position of the item in the logical local iteration space.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Global ID

                                                                                                                                                                                                                                              Definition at line 897 of file item.h.

                                                                                                                                                                                                                                              ◆ get_logical_local_id() [2/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              size_t cl::sycl::h_item< dimensions >::get_logical_local_id ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the value of the logical local ID for the specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionWhich value of the ID to retrieve
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Element of the logical local ID

                                                                                                                                                                                                                                              Definition at line 906 of file item.h.

                                                                                                                                                                                                                                              ◆ get_logical_local_range() [1/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              range<dimensions> cl::sycl::h_item< dimensions >::get_logical_local_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the range representing the sizes of the logical local iteration space.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Global range

                                                                                                                                                                                                                                              Definition at line 880 of file item.h.

                                                                                                                                                                                                                                              ◆ get_logical_local_range() [2/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              size_t cl::sycl::h_item< dimensions >::get_logical_local_range ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the value of the logical local range for the specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionWhich value of the range to retrieve
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Element of the logical local range

                                                                                                                                                                                                                                              Definition at line 889 of file item.h.

                                                                                                                                                                                                                                              ◆ get_physical_local()

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              item<dimensions, false> cl::sycl::h_item< dimensions >::get_physical_local ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the constituent physical local item representing the work-item's position in the local iteration space as provided upon the invocation of parallel_for_work_group.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Item representing the physical local ID and range

                                                                                                                                                                                                                                              Definition at line 806 of file item.h.

                                                                                                                                                                                                                                              ◆ get_physical_local_id() [1/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              id<dimensions> cl::sycl::h_item< dimensions >::get_physical_local_id ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the id representing the position of the item in the physical local iteration space.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Global ID

                                                                                                                                                                                                                                              Definition at line 931 of file item.h.

                                                                                                                                                                                                                                              ◆ get_physical_local_id() [2/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              size_t cl::sycl::h_item< dimensions >::get_physical_local_id ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the value of the physical local ID for the specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionWhich value of the ID to retrieve
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Element of the physical local ID

                                                                                                                                                                                                                                              Definition at line 940 of file item.h.

                                                                                                                                                                                                                                              ◆ get_physical_local_range() [1/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              range<dimensions> cl::sycl::h_item< dimensions >::get_physical_local_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the range representing the sizes of the physical local iteration space.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Global range

                                                                                                                                                                                                                                              Definition at line 914 of file item.h.

                                                                                                                                                                                                                                              ◆ get_physical_local_range() [2/2]

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              size_t cl::sycl::h_item< dimensions >::get_physical_local_range ( int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Retrieves the value of the physical local range for the specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionWhich value of the range to retrieve
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Element of the physical local range

                                                                                                                                                                                                                                              Definition at line 923 of file item.h.

                                                                                                                                                                                                                                              ◆ is_equal()

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              bool cl::sycl::h_item< dimensions >::is_equal ( const h_item< dimensions > &  rhs) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Helper function for calling operator==()

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

                                                                                                                                                                                                                                              Definition at line 948 of file item.h.

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ operator!=

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              bool operator!= ( const h_item< dimensions > &  lhs,
                                                                                                                                                                                                                                              const h_item< dimensions > &  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 771 of file item.h.

                                                                                                                                                                                                                                              ◆ operator==

                                                                                                                                                                                                                                              template<int dimensions>
                                                                                                                                                                                                                                              bool operator== ( const h_item< dimensions > &  lhs,
                                                                                                                                                                                                                                              const h_item< dimensions > &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Equality operator.

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

                                                                                                                                                                                                                                              Definition at line 762 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.