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

                                                                                                                                                                                                                                              Implements the nd_range class of the SYCL specification. More...

                                                                                                                                                                                                                                              #include <base.h>

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

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               nd_range (const range< dimensions > globalRange, const range< dimensions > localRange, const id< dimensions > globalOffset=id< dimensions >())
                                                                                                                                                                                                                                               Construct a nd_range object specifying the global and local range and an optional offset. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               nd_range (const detail::nd_range_base &ndRangeBase)
                                                                                                                                                                                                                                               Copy constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               COMPUTECPP_DEPRECATED_API ("SYCL 1.2.1 revision 3 replaces nd_range::get_global with " "nd_range::get_global_range.") range< dimensions > get_global() const
                                                                                                                                                                                                                                               Return the global range. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< dimensions > get_global_range () const
                                                                                                                                                                                                                                               Return the global range. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               COMPUTECPP_DEPRECATED_API ("SYCL 1.2.1 revision 3 replaces nd_range::get_local with " "nd_range::get_local_range.") range< dimensions > get_local() const
                                                                                                                                                                                                                                               Return the local range. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< dimensions > get_local_range () const
                                                                                                                                                                                                                                               Return the local range. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               COMPUTECPP_DEPRECATED_API ("SYCL 1.2.1 revision 3 replaces nd_range::get_group with " "nd_range::get_group_range.") range< dimensions > get_group() const
                                                                                                                                                                                                                                               Compute the group range. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              range< dimensions > get_group_range () const
                                                                                                                                                                                                                                               Compute the group range. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              id< dimensions > get_offset () const
                                                                                                                                                                                                                                               Return the queue offset. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

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

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              class cl::sycl::nd_range< dimensions >

                                                                                                                                                                                                                                              Implements the nd_range class of the SYCL specification.

                                                                                                                                                                                                                                              An nd_range contains a global and a local range and an offset.

                                                                                                                                                                                                                                              Definition at line 39 of file base.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ nd_range() [1/2]

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              cl::sycl::nd_range< dimensions >::nd_range ( const range< dimensions >  globalRange,
                                                                                                                                                                                                                                              const range< dimensions >  localRange,
                                                                                                                                                                                                                                              const id< dimensions >  globalOffset = id<dimensions>() 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Construct a nd_range object specifying the global and local range and an optional offset.

                                                                                                                                                                                                                                              Note that the global range must divisible by the local range in order to be usable by a handler::parallel_for.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              globalRangeThe global range
                                                                                                                                                                                                                                              localRangeThe local range
                                                                                                                                                                                                                                              globalOffsetThe global offset (optional, default to 0)

                                                                                                                                                                                                                                              Definition at line 222 of file range.h.

                                                                                                                                                                                                                                              ◆ nd_range() [2/2]

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              cl::sycl::nd_range< dimensions >::nd_range ( const detail::nd_range_base &  ndRangeBase)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Copy constructor.

                                                                                                                                                                                                                                              Create a copy of another nd_range.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              ndRangeBaseThe nd_range to copy

                                                                                                                                                                                                                                              Definition at line 229 of file range.h.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ COMPUTECPP_DEPRECATED_API() [1/3]

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              cl::sycl::nd_range< dimensions >::COMPUTECPP_DEPRECATED_API ( "SYCL 1.2.1 revision 3 replaces nd_range< dimensions >::get_global with " "nd_range< dimensions >::get_global_range."  ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Return the global range.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The global range

                                                                                                                                                                                                                                              Definition at line 236 of file range.h.

                                                                                                                                                                                                                                              ◆ COMPUTECPP_DEPRECATED_API() [2/3]

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              cl::sycl::nd_range< dimensions >::COMPUTECPP_DEPRECATED_API ( "SYCL 1.2.1 revision 3 replaces nd_range< dimensions >::get_local with " "nd_range< dimensions >::get_local_range."  ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Return the local range.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The local range

                                                                                                                                                                                                                                              Definition at line 250 of file range.h.

                                                                                                                                                                                                                                              ◆ COMPUTECPP_DEPRECATED_API() [3/3]

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              cl::sycl::nd_range< dimensions >::COMPUTECPP_DEPRECATED_API ( "SYCL 1.2.1 revision 3 replaces nd_range< dimensions >::get_group with " "nd_range< dimensions >::get_group_range."  ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Compute the group range.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The group range

                                                                                                                                                                                                                                              Definition at line 265 of file range.h.

                                                                                                                                                                                                                                              ◆ get_global_range()

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              range<dimensions> cl::sycl::nd_range< dimensions >::get_global_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Return the global range.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The global range

                                                                                                                                                                                                                                              Definition at line 244 of file range.h.

                                                                                                                                                                                                                                              ◆ get_group_range()

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              range<dimensions> cl::sycl::nd_range< dimensions >::get_group_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Compute the group range.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The group range

                                                                                                                                                                                                                                              Definition at line 273 of file range.h.

                                                                                                                                                                                                                                              ◆ get_local_range()

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              range<dimensions> cl::sycl::nd_range< dimensions >::get_local_range ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Return the local range.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The local range

                                                                                                                                                                                                                                              Definition at line 258 of file range.h.

                                                                                                                                                                                                                                              ◆ get_offset()

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              id<dimensions> cl::sycl::nd_range< dimensions >::get_offset ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Return the queue offset.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The offset

                                                                                                                                                                                                                                              Definition at line 280 of file range.h.

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ operator!=

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              bool operator!= ( const nd_range< dimensions > &  lhs,
                                                                                                                                                                                                                                              const nd_range< 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 295 of file range.h.

                                                                                                                                                                                                                                              ◆ operator==

                                                                                                                                                                                                                                              template<int dimensions = 1>
                                                                                                                                                                                                                                              bool operator== ( const nd_range< dimensions > &  lhs,
                                                                                                                                                                                                                                              const nd_range< 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 286 of file range.h.

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

                                                                                                                                                                                                                                              Select a Product

                                                                                                                                                                                                                                              Please select a product

                                                                                                                                                                                                                                              oneAPI

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

                                                                                                                                                                                                                                              Dark Mode
                                                                                                                                                                                                                                              brightness_2

                                                                                                                                                                                                                                              Dark Mode

                                                                                                                                                                                                                                              Light text on a dark background.

                                                                                                                                                                                                                                              Light Mode
                                                                                                                                                                                                                                              lightbulb_outline

                                                                                                                                                                                                                                              Light Mode

                                                                                                                                                                                                                                              Dark text on a light background.

                                                                                                                                                                                                                                              public

                                                                                                                                                                                                                                              Also,

                                                                                                                                                                                                                                              part of our network

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

                                                                                                                                                                                                                                              Please type to begin searching or try these:


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