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::multi_ptr< const void, asp > Class Template Reference

                                                                                                                                                                                                                                              Generic pointer class, specialization for const void. More...

                                                                                                                                                                                                                                              #include <multi_pointer.h>

                                                                                                                                                                                                                                              Inheritance diagram for cl::sycl::multi_ptr< const void, asp >:

                                                                                                                                                                                                                                              Public Types

                                                                                                                                                                                                                                              using value_type = typename multi_ptr_base::element_type
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using difference_type = typename multi_ptr_base::difference_type
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using pointer = typename multi_ptr_base::pointer_t
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using pointer = typename multi_ptr_base::const_pointer_t
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               multi_ptr ()=default
                                                                                                                                                                                                                                               Default constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               multi_ptr (ptr_t ptr)
                                                                                                                                                                                                                                               Initialize the object using the given pointer. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<int dimensions, access::mode Mode, access::placeholder isPlaceholder = access::placeholder::false_t, COMPUTECPP_ENABLE_IF(const void,(detail::address_space_trait< const void, asp >::hasTarget)) >
                                                                                                                                                                                                                                               multi_ptr (cl::sycl::accessor< const void, dimensions, Mode, detail::address_space_trait< const void, asp >::targetValue, isPlaceholder > acc)
                                                                                                                                                                                                                                               Initialize the object using an accessor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(const void,(!std::is_same< ptr_t, ptr_unqual_t >::value)) >
                                                                                                                                                                                                                                               multi_ptr (ptr_unqual_t ptr)
                                                                                                                                                                                                                                               Initialize the object using the given non address space qualified pointer. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename ElementType , COMPUTECPP_ENABLE_IF( ElementType,(!std::is_same< ElementType, const void >::value)) >
                                                                                                                                                                                                                                               multi_ptr (const multi_ptr< ElementType, asp > &ptr)
                                                                                                                                                                                                                                               Explicit conversion from a multi_ptr<ElementType> More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename ElementType , int dimensions, access::mode Mode, access::placeholder isPlaceholder, COMPUTECPP_ENABLE_IF( ElementType,(detail::address_space_trait< ElementType, asp >::hasTarget)) >
                                                                                                                                                                                                                                               multi_ptr (accessor< ElementType, dimensions, Mode, detail::address_space_trait< ElementType, asp >::targetValue, isPlaceholder > acc)
                                                                                                                                                                                                                                               Initialize the object using an accessor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<typename ElementType >
                                                                                                                                                                                                                                               operator multi_ptr< ElementType, asp > () const
                                                                                                                                                                                                                                               Explicit conversion to a multi_ptr<ElementType> More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Types

                                                                                                                                                                                                                                              using multi_ptr_base = detail::multi_ptr_base< const void, asp >
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              class cl::sycl::multi_ptr< const void, asp >

                                                                                                                                                                                                                                              Generic pointer class, specialization for const void.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              aspThe address space the pointer class points to.

                                                                                                                                                                                                                                              Definition at line 989 of file multi_pointer.h.

                                                                                                                                                                                                                                              Member Typedef Documentation

                                                                                                                                                                                                                                              ◆ difference_type

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< const void, asp >::difference_type = typename multi_ptr_base::difference_type

                                                                                                                                                                                                                                              Definition at line 1011 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr_base

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< const void, asp >::multi_ptr_base = detail::multi_ptr_base<const void, asp>
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Definition at line 992 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ pointer [1/2]

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< const void, asp >::pointer = typename multi_ptr_base::pointer_t

                                                                                                                                                                                                                                              Definition at line 1013 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ pointer [2/2]

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< const void, asp >::pointer = typename multi_ptr_base::const_pointer_t

                                                                                                                                                                                                                                              Definition at line 1016 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ value_type

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< const void, asp >::value_type = typename multi_ptr_base::element_type

                                                                                                                                                                                                                                              Definition at line 1010 of file multi_pointer.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ multi_ptr() [1/6]

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< const void, asp >::multi_ptr ( )
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Default constructor.

                                                                                                                                                                                                                                              ◆ multi_ptr() [2/6]

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< const void, asp >::multi_ptr ( ptr_t  ptr)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Initialize the object using the given pointer.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              ptrPointer that the class should manipulate.

                                                                                                                                                                                                                                              Definition at line 1037 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr() [3/6]

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              template<int dimensions, access::mode Mode, access::placeholder isPlaceholder = access::placeholder::false_t, COMPUTECPP_ENABLE_IF(const void,(detail::address_space_trait< const void, asp >::hasTarget)) >
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< const void, asp >::multi_ptr ( cl::sycl::accessor< const void, dimensions, Mode, detail::address_space_trait< const void, asp >::targetValue, isPlaceholder >  acc)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Initialize the object using an accessor.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              dimensionsAccessor dimensions
                                                                                                                                                                                                                                              ModeAccessor mode
                                                                                                                                                                                                                                              isPlaceholderWhether the accessor is a placeholder
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFThis constructor is only available for access::address_space::global_space access::address_space::constant_space access::address_space::local_space
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              accAccessor to retrieve the pointer from

                                                                                                                                                                                                                                              Definition at line 1053 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr() [4/6]

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(const void,(!std::is_same< ptr_t, ptr_unqual_t >::value)) >
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< const void, asp >::multi_ptr ( ptr_unqual_t  ptr)

                                                                                                                                                                                                                                              Initialize the object using the given non address space qualified pointer.

                                                                                                                                                                                                                                              This conversion is defined by the device compiler.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly available if the provided pointer is not address space qualified.
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              ptrPointer that is not address space qualified that the class should manipulate
                                                                                                                                                                                                                                              Note
                                                                                                                                                                                                                                              This constructor has to be declared in order for the offload device compiler to deduce address spaces, but it should not be defined because it should never actually be used in Offload. It is used in the ASP compiler, however.

                                                                                                                                                                                                                                              ◆ multi_ptr() [5/6]

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              template<typename ElementType , COMPUTECPP_ENABLE_IF( ElementType,(!std::is_same< ElementType, const void >::value)) >
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< const void, asp >::multi_ptr ( const multi_ptr< ElementType, asp > &  ptr)
                                                                                                                                                                                                                                              		inlineexplicit

                                                                                                                                                                                                                                              Explicit conversion from a multi_ptr<ElementType>

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              ElementTypeUnderlying type of the pointer to convert
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly enabled if ElementType is not const void
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              ptrPointer to convert to multi_ptr<const void>

                                                                                                                                                                                                                                              Definition at line 1091 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr() [6/6]

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              template<typename ElementType , int dimensions, access::mode Mode, access::placeholder isPlaceholder, COMPUTECPP_ENABLE_IF( ElementType,(detail::address_space_trait< ElementType, asp >::hasTarget)) >
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< const void, asp >::multi_ptr ( accessor< ElementType, dimensions, Mode, detail::address_space_trait< ElementType, asp >::targetValue, isPlaceholder >  acc)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Initialize the object using an accessor.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              ElementTypeUnderlying type of the accessor data
                                                                                                                                                                                                                                              dimensionsAccessor dimensions
                                                                                                                                                                                                                                              ModeAccessor mode
                                                                                                                                                                                                                                              isPlaceholderWhether the accessor is a placeholder
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFThis constructor is only available for access::address_space::global_space access::address_space::constant_space access::address_space::local_space
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              accAccessor to retrieve the pointer from

                                                                                                                                                                                                                                              Definition at line 1110 of file multi_pointer.h.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ operator multi_ptr< ElementType, asp >()

                                                                                                                                                                                                                                              template<cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              template<typename ElementType >
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< const void, asp >::operator multi_ptr< ElementType, asp > ( ) const
                                                                                                                                                                                                                                              		inlineexplicit

                                                                                                                                                                                                                                              Explicit conversion to a multi_ptr<ElementType>

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              This pointer object converted to a multi_ptr<ElementType>

                                                                                                                                                                                                                                              Definition at line 1120 of file multi_pointer.h.

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

                                                                                                                                                                                                                                              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.