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::group< Dimensions > Class Template Reference

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

                                                                                                                                                                                                                                              #include <base.h>

                                                                                                                                                                                                                                              Inheritance diagram for cl::sycl::group< Dimensions >:

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               group (const detail::group_base &gb)
                                                                                                                                                                                                                                               Conversion constructor from group<Dimensions> to group_base This constructor is used in all of the kernel invocation APIs that use the group class. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              id< Dimensions > get () const
                                                                                                                                                                                                                                               Get Group ID. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use group::get_id(unsigned) instead.") size_t get(unsigned int dimension) const
                                                                                                                                                                                                                                               Get Group ID. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              id< Dimensions > get_id () const
                                                                                                                                                                                                                                               Get Group ID. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_id (unsigned int dimension) const
                                                                                                                                                                                                                                               Get Group ID. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< Dimensions > get_global_range () const
                                                                                                                                                                                                                                               Get the global range for all dimensions. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_global_range (unsigned int dimension) const
                                                                                                                                                                                                                                               Returns the global range in a specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< Dimensions > get_local_range () const
                                                                                                                                                                                                                                               Get the local range for all dimensions. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_local_range (unsigned int dimension) const
                                                                                                                                                                                                                                               Returns the local range in a specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< Dimensions > get_group_range () const
                                                                                                                                                                                                                                               the group range for all dimensions More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_group_range (unsigned int dimension) const
                                                                                                                                                                                                                                               Returns the group range in a specified dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t operator[] (size_t dim) const
                                                                                                                                                                                                                                               Get the value for the given dimension. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename... eventTN>
                                                                                                                                                                                                                                              void wait_for (eventTN... events) const
                                                                                                                                                                                                                                               Waits on each given device_event. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename workItemFunctionT >
                                                                                                                                                                                                                                              void parallel_for_work_item (const workItemFunctionT &func) const
                                                                                                                                                                                                                                               Inner loop of parallel_for_work_group. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename workItemFunctionT >
                                                                                                                                                                                                                                              void parallel_for_work_item (range< Dimensions > flexibleRange_, const workItemFunctionT &func) const
                                                                                                                                                                                                                                               Inner loop of parallel_for_work_group. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename dataT >
                                                                                                                                                                                                                                              COMPUTECPP_PRIVATE device_event async_work_group_copy (local_ptr< dataT > dest, global_ptr< dataT > src, size_t numElements) const
                                                                                                                                                                                                                                               Asynchronous work group copy from a global pointer to local. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename dataT >
                                                                                                                                                                                                                                              COMPUTECPP_PRIVATE device_event async_work_group_copy (global_ptr< dataT > dest, local_ptr< dataT > src, size_t numElements) const
                                                                                                                                                                                                                                               Asynchronous work group copy from a local pointer to global. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename dataT >
                                                                                                                                                                                                                                              COMPUTECPP_PRIVATE device_event async_work_group_copy (local_ptr< dataT > dest, global_ptr< dataT > src, size_t numElements, size_t srcStride) const
                                                                                                                                                                                                                                               Asynchronous work group copy from a global pointer to local. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename dataT >
                                                                                                                                                                                                                                              COMPUTECPP_PRIVATE device_event async_work_group_copy (global_ptr< dataT > dest, local_ptr< dataT > src, size_t numElements, size_t destStride) const
                                                                                                                                                                                                                                               Asynchronous work group copy from a local pointer to global. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Member Functions

                                                                                                                                                                                                                                              bool is_zero_id () const
                                                                                                                                                                                                                                               Checks if the ID of this group is all zeros. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

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

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              class cl::sycl::group< Dimensions >

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

                                                                                                                                                                                                                                              Forward declaration for sycl::group class.

                                                                                                                                                                                                                                              The cl::sycl::group object is used within the parallel_for_work_group function. The cl::sycl::group object can return information about the local and global sizes of an enqueued nd-range as well as the number of groups and the current group id.

                                                                                                                                                                                                                                              Definition at line 51 of file base.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ group()

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              cl::sycl::group< Dimensions >::group ( const detail::group_base &  gb)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Conversion constructor from group<Dimensions> to group_base This constructor is used in all of the kernel invocation APIs that use the group class.

                                                                                                                                                                                                                                              Definition at line 95 of file group.h.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ async_work_group_copy() [1/4]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              template<typename dataT >
                                                                                                                                                                                                                                              COMPUTECPP_PRIVATE device_event cl::sycl::group< Dimensions >::async_work_group_copy ( local_ptr< dataT >  dest,
                                                                                                                                                                                                                                              global_ptr< dataT >  src,
                                                                                                                                                                                                                                              size_t  numElements 
                                                                                                                                                                                                                                              ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Asynchronous work group copy from a global pointer to local.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              dataTData type of the pointer
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              destPointer to the destination in local memory
                                                                                                                                                                                                                                              srcPointer to the source in global memory
                                                                                                                                                                                                                                              numElementsNumber of elements to copy

                                                                                                                                                                                                                                              Definition at line 295 of file group.h.

                                                                                                                                                                                                                                              ◆ async_work_group_copy() [2/4]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              template<typename dataT >
                                                                                                                                                                                                                                              COMPUTECPP_PRIVATE device_event cl::sycl::group< Dimensions >::async_work_group_copy ( global_ptr< dataT >  dest,
                                                                                                                                                                                                                                              local_ptr< dataT >  src,
                                                                                                                                                                                                                                              size_t  numElements 
                                                                                                                                                                                                                                              ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Asynchronous work group copy from a local pointer to global.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              dataTData type of the pointer
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              destPointer to the destination in global memory
                                                                                                                                                                                                                                              srcPointer to the source in local memory
                                                                                                                                                                                                                                              numElementsNumber of elements to copy

                                                                                                                                                                                                                                              Definition at line 308 of file group.h.

                                                                                                                                                                                                                                              ◆ async_work_group_copy() [3/4]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              template<typename dataT >
                                                                                                                                                                                                                                              COMPUTECPP_PRIVATE device_event cl::sycl::group< Dimensions >::async_work_group_copy ( local_ptr< dataT >  dest,
                                                                                                                                                                                                                                              global_ptr< dataT >  src,
                                                                                                                                                                                                                                              size_t  numElements,
                                                                                                                                                                                                                                              size_t  srcStride 
                                                                                                                                                                                                                                              ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Asynchronous work group copy from a global pointer to local.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              dataTData type of the pointer
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              destPointer to the destination in local memory
                                                                                                                                                                                                                                              srcPointer to the source in global memory
                                                                                                                                                                                                                                              numElementsNumber of elements to copy
                                                                                                                                                                                                                                              destStrideStride in the origin

                                                                                                                                                                                                                                              Definition at line 323 of file group.h.

                                                                                                                                                                                                                                              ◆ async_work_group_copy() [4/4]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              template<typename dataT >
                                                                                                                                                                                                                                              COMPUTECPP_PRIVATE device_event cl::sycl::group< Dimensions >::async_work_group_copy ( global_ptr< dataT >  dest,
                                                                                                                                                                                                                                              local_ptr< dataT >  src,
                                                                                                                                                                                                                                              size_t  numElements,
                                                                                                                                                                                                                                              size_t  destStride 
                                                                                                                                                                                                                                              ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Asynchronous work group copy from a local pointer to global.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              dataTData type of the pointer
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              destPointer to the destination in global memory
                                                                                                                                                                                                                                              srcPointer to the source in local memory
                                                                                                                                                                                                                                              numElementsNumber of elements to copy
                                                                                                                                                                                                                                              destStrideStride in the destination

                                                                                                                                                                                                                                              Definition at line 338 of file group.h.

                                                                                                                                                                                                                                              ◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER()

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              cl::sycl::group< Dimensions >::COMPUTECPP_DEPRECATED_BY_SYCL_VER ( 201703  ,
                                                                                                                                                                                                                                              "Use group< Dimensions >::get_id(unsigned) instead."   
                                                                                                                                                                                                                                              ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get Group ID.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              thedimension of the nd_range we should return the group ID for
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the group id for that dimension
                                                                                                                                                                                                                                              Deprecated:
                                                                                                                                                                                                                                              Use get_id instead

                                                                                                                                                                                                                                              Definition at line 127 of file group.h.

                                                                                                                                                                                                                                              ◆ get()

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              id<Dimensions> cl::sycl::group< Dimensions >::get ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get Group ID.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the group id for all dimensions of the nd_range
                                                                                                                                                                                                                                              Deprecated:
                                                                                                                                                                                                                                              Use get_id instead

                                                                                                                                                                                                                                              Definition at line 120 of file group.h.

                                                                                                                                                                                                                                              ◆ get_global_range() [1/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              range<Dimensions> cl::sycl::group< Dimensions >::get_global_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get the global range for all dimensions.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the value of the global range for each dimension of the nd_range.

                                                                                                                                                                                                                                              Definition at line 145 of file group.h.

                                                                                                                                                                                                                                              ◆ get_global_range() [2/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              size_t cl::sycl::group< Dimensions >::get_global_range ( unsigned int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Returns the global range in a specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionthe dimension of the global range to be returned.
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the value of the global range in the specified dimension.

                                                                                                                                                                                                                                              Definition at line 153 of file group.h.

                                                                                                                                                                                                                                              ◆ get_group_range() [1/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              range<Dimensions> cl::sycl::group< Dimensions >::get_group_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              the group range for all dimensions

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the value of the group range for each dimension of the group.

                                                                                                                                                                                                                                              Definition at line 187 of file group.h.

                                                                                                                                                                                                                                              ◆ get_group_range() [2/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              size_t cl::sycl::group< Dimensions >::get_group_range ( unsigned int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Returns the group range in a specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionthe dimension of the group range to be returned.
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the value of the group range in the specified dimension.

                                                                                                                                                                                                                                              Definition at line 195 of file group.h.

                                                                                                                                                                                                                                              ◆ get_id() [1/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              id<Dimensions> cl::sycl::group< Dimensions >::get_id ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get Group ID.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the group id for all dimensions of the nd_range

                                                                                                                                                                                                                                              Definition at line 134 of file group.h.

                                                                                                                                                                                                                                              ◆ get_id() [2/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              size_t cl::sycl::group< Dimensions >::get_id ( unsigned int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get Group ID.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              thedimension of the nd_range we should return the group ID for
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the group id for that dimension

                                                                                                                                                                                                                                              Definition at line 140 of file group.h.

                                                                                                                                                                                                                                              ◆ get_local_range() [1/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              range<Dimensions> cl::sycl::group< Dimensions >::get_local_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get the local range for all dimensions.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the value of the local range for each dimension of the nd_range.

                                                                                                                                                                                                                                              Definition at line 160 of file group.h.

                                                                                                                                                                                                                                              ◆ get_local_range() [2/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              size_t cl::sycl::group< Dimensions >::get_local_range ( unsigned int  dimension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Returns the local range in a specified dimension.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              dimensionthe dimension of the local range to be returned.
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              the value of the local range in the specified dimension.

                                                                                                                                                                                                                                              Definition at line 168 of file group.h.

                                                                                                                                                                                                                                              ◆ is_zero_id()

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              bool cl::sycl::group< Dimensions >::is_zero_id ( ) const
                                                                                                                                                                                                                                              		inlineprotected

                                                                                                                                                                                                                                              Checks if the ID of this group is all zeros.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if current ID is (0, 0, 0)

                                                                                                                                                                                                                                              Definition at line 68 of file group.h.

                                                                                                                                                                                                                                              ◆ operator[]()

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              size_t cl::sycl::group< Dimensions >::operator[] ( size_t  dim) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get the value for the given dimension.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              size_t with the value for the given dimension

                                                                                                                                                                                                                                              Definition at line 202 of file group.h.

                                                                                                                                                                                                                                              ◆ parallel_for_work_item() [1/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              template<typename workItemFunctionT >
                                                                                                                                                                                                                                              void cl::sycl::group< Dimensions >::parallel_for_work_item ( const workItemFunctionT &  func) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Inner loop of parallel_for_work_group.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              workItemFunctionTType of the functor to execute hierarchically
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              funcThe functor to execute

                                                                                                                                                                                                                                              Definition at line 228 of file group.h.

                                                                                                                                                                                                                                              ◆ parallel_for_work_item() [2/2]

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              template<typename workItemFunctionT >
                                                                                                                                                                                                                                              void cl::sycl::group< Dimensions >::parallel_for_work_item ( range< Dimensions >  flexibleRange_,
                                                                                                                                                                                                                                              const workItemFunctionT &  func 
                                                                                                                                                                                                                                              ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Inner loop of parallel_for_work_group.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              workItemFunctionTType of the functor to execute hierarchically
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              flexibleRange_The logical local range
                                                                                                                                                                                                                                              funcThe functor to execute

                                                                                                                                                                                                                                              Definition at line 238 of file group.h.

                                                                                                                                                                                                                                              ◆ wait_for()

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              template<typename... eventTN>
                                                                                                                                                                                                                                              void cl::sycl::group< Dimensions >::wait_for ( eventTN...  events) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Waits on each given device_event.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              eventTNPack of device_event types
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              eventsPack of device_events

                                                                                                                                                                                                                                              Definition at line 211 of file group.h.

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ operator!=

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              bool operator!= ( const group< Dimensions > &  lhs,
                                                                                                                                                                                                                                              const group< 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 111 of file group.h.

                                                                                                                                                                                                                                              ◆ operator==

                                                                                                                                                                                                                                              template<int Dimensions = 1>
                                                                                                                                                                                                                                              bool operator== ( const group< Dimensions > &  lhs,
                                                                                                                                                                                                                                              const group< 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 102 of file group.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