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< dataType, asp > Class Template Reference

                                                                                                                                                                                                                                              multi_ptr, generic pointer class. More...

                                                                                                                                                                                                                                              #include <multi_pointer.h>

                                                                                                                                                                                                                                              Inheritance diagram for cl::sycl::multi_ptr< dataType, asp >:

                                                                                                                                                                                                                                              Public Types

                                                                                                                                                                                                                                              using reference = typename multi_ptr_base::asp_type &
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using reference = const typename multi_ptr_base::asp_type &
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using value_type = typename multi_ptr_base::element_type
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using difference_type = typename multi_ptr_base::difference_type
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using pointer = ptr_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<COMPUTECPP_ENABLE_IF(dataType,(std::is_const< dataType >::value)) >
                                                                                                                                                                                                                                               multi_ptr (const multi_ptr< non_const_data_t, asp > &rhs)
                                                                                                                                                                                                                                               Copy constructor from a non-const multi_ptr. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               multi_ptr (const multi_ptr< void, asp > &rhs)
                                                                                                                                                                                                                                               Copy constructor from a void multi_ptr. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(dataType,(std::is_const< dataType >::value)) >
                                                                                                                                                                                                                                               multi_ptr (const multi_ptr< const void, asp > &rhs)
                                                                                                                                                                                                                                               Copy constructor from a const void multi_ptr. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<int dimensions, access::mode Mode, access::placeholder isPlaceholder = access::placeholder::false_t, COMPUTECPP_ENABLE_IF(dataType,(detail::address_space_trait< dataType, asp >::hasTarget)) >
                                                                                                                                                                                                                                               multi_ptr (cl::sycl::accessor< non_const_data_t, dimensions, Mode, detail::address_space_trait< non_const_data_t, asp >::targetValue, isPlaceholder > acc)
                                                                                                                                                                                                                                               Initialize the object using an accessor to non-const data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<int dimensions, access::mode Mode, access::placeholder isPlaceholder = access::placeholder::false_t, COMPUTECPP_ENABLE_IF(dataType,(detail::address_space_trait< dataType, asp >::hasTarget && std::is_const< dataType >::value)) >
                                                                                                                                                                                                                                               multi_ptr (cl::sycl::accessor< const non_const_data_t, dimensions, Mode, detail::address_space_trait< const non_const_data_t, asp >::targetValue, isPlaceholder > acc)
                                                                                                                                                                                                                                               Initialize the object using an accessor to const data. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(dataType,(!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...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               operator multi_ptr< void_conversion_t, asp > () const
                                                                                                                                                                                                                                               Implicit conversion to multi_ptr<(const) void>. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              original_type_ref operator* ()
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              original_type_cref operator* () const
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "multi_ptr::operator[] is no longer available.") original_type_ref operator[](size_t i)
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "multi_ptr::operator[] is no longer available.") original_type_cref operator[](size_t i) const
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              multi_ptr & operator++ ()
                                                                                                                                                                                                                                               Increments the underlying pointer by 1. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              multi_ptr operator++ (int)
                                                                                                                                                                                                                                               Increments the underlying pointer by 1 and returns a new multi_ptr with the value of the previous pointer. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              multi_ptr & operator-- ()
                                                                                                                                                                                                                                               Decrements the underlying pointer by 1. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              multi_ptr operator-- (int)
                                                                                                                                                                                                                                               Decrements the underlying pointer by 1 and returns a new multi_ptr with the value of the previous pointer. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              multi_ptr & operator+= (difference_type r)
                                                                                                                                                                                                                                               Increments the underlying pointer by r. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              multi_ptr operator+ (difference_type r) const
                                                                                                                                                                                                                                               Creates a new multi_ptr that points r forward compared to *this. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              multi_ptr & operator-= (difference_type r)
                                                                                                                                                                                                                                               Decrements the underlying pointer by r. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              multi_ptr operator- (difference_type r) const
                                                                                                                                                                                                                                               Creates a new multi_ptr that points r backward compared to *this. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Types

                                                                                                                                                                                                                                              using multi_ptr_base = detail::multi_ptr_base< dataType, asp >
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using original_type_ref = typename detail::address_space_trait< dataType, asp >::original_type &
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using original_type_cref = const typename detail::address_space_trait< dataType, asp >::original_type &
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using non_const_data_t = typename std::remove_const< dataType >::type
                                                                                                                                                                                                                                               Alias to the non-const qualified data type. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              using void_conversion_t = typename std::conditional< std::is_const< dataType >::value, const void, void >::type
                                                                                                                                                                                                                                               A void type with const-ness matching the value_type of this pointer. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              class cl::sycl::multi_ptr< dataType, asp >

                                                                                                                                                                                                                                              multi_ptr, generic pointer class.

                                                                                                                                                                                                                                              This class have the same interface as the explicit pointer classes (global_ptr, private_ptr, local_ptr and constant_ptr). The address space where the data point to is defined by the template parameter Space. A cast operator allow the conversion from a multi_ptr object to its equivalent explicit one.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              dataTypeData type the object manipulates.
                                                                                                                                                                                                                                              aspThe address space the pointer class points to.

                                                                                                                                                                                                                                              Definition at line 518 of file multi_pointer.h.

                                                                                                                                                                                                                                              Member Typedef Documentation

                                                                                                                                                                                                                                              ◆ difference_type

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

                                                                                                                                                                                                                                              Definition at line 559 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr_base

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

                                                                                                                                                                                                                                              Definition at line 520 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ non_const_data_t

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< dataType, asp >::non_const_data_t = typename std::remove_const<dataType>::type
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Alias to the non-const qualified data type.

                                                                                                                                                                                                                                              Definition at line 529 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ original_type_cref

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< dataType, asp >::original_type_cref = const typename detail::address_space_trait<dataType, asp>::original_type&
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Definition at line 525 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ original_type_ref

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< dataType, asp >::original_type_ref = typename detail::address_space_trait<dataType, asp>::original_type&
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Definition at line 523 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ pointer [1/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< dataType, asp >::pointer = ptr_t

                                                                                                                                                                                                                                              Definition at line 561 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ pointer [2/2]

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

                                                                                                                                                                                                                                              Definition at line 564 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ reference [1/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< dataType, asp >::reference = typename multi_ptr_base::asp_type&

                                                                                                                                                                                                                                              Definition at line 549 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ reference [2/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< dataType, asp >::reference = const typename multi_ptr_base::asp_type&

                                                                                                                                                                                                                                              Definition at line 555 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ value_type

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

                                                                                                                                                                                                                                              Definition at line 558 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ void_conversion_t

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              using cl::sycl::multi_ptr< dataType, asp >::void_conversion_t = typename std::conditional<std::is_const<dataType>::value, const void, void>::type
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              A void type with const-ness matching the value_type of this pointer.

                                                                                                                                                                                                                                              Definition at line 700 of file multi_pointer.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ multi_ptr() [1/8]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< dataType, asp >::multi_ptr ( )
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Default constructor.

                                                                                                                                                                                                                                              ◆ multi_ptr() [2/8]

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

                                                                                                                                                                                                                                              Initialize the object using the given pointer.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              ptrPointer that the class should manipulate.

                                                                                                                                                                                                                                              Definition at line 587 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr() [3/8]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(dataType,(std::is_const< dataType >::value)) >
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< dataType, asp >::multi_ptr ( const multi_ptr< non_const_data_t, asp > &  rhs)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Copy constructor from a non-const multi_ptr.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly available when dataType is const
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rhsNon-const multi_ptr

                                                                                                                                                                                                                                              Definition at line 594 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr() [4/8]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< dataType, asp >::multi_ptr ( const multi_ptr< void, asp > &  rhs)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Copy constructor from a void multi_ptr.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rhsvoid multi_ptr

                                                                                                                                                                                                                                              Definition at line 605 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr() [5/8]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(dataType,(std::is_const< dataType >::value)) >
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< dataType, asp >::multi_ptr ( const multi_ptr< const void, asp > &  rhs)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Copy constructor from a const void multi_ptr.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              COMPUTECPP_ENABLE_IFOnly available when dataType is const
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rhsconst void multi_ptr

                                                                                                                                                                                                                                              Definition at line 620 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr() [6/8]

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

                                                                                                                                                                                                                                              Initialize the object using an accessor to non-const data.

                                                                                                                                                                                                                                              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. It is available regardless of dataType being const or not.
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              accAccessor to retrieve the pointer from

                                                                                                                                                                                                                                              Definition at line 639 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr() [7/8]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              template<int dimensions, access::mode Mode, access::placeholder isPlaceholder = access::placeholder::false_t, COMPUTECPP_ENABLE_IF(dataType,(detail::address_space_trait< dataType, asp >::hasTarget && std::is_const< dataType >::value)) >
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< dataType, asp >::multi_ptr ( cl::sycl::accessor< const non_const_data_t, dimensions, Mode, detail::address_space_trait< const non_const_data_t, asp >::targetValue, isPlaceholder >  acc)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Initialize the object using an accessor to const data.

                                                                                                                                                                                                                                              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. Available only if dataType is const.
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              accAccessor to retrieve the pointer from

                                                                                                                                                                                                                                              Definition at line 662 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ multi_ptr() [8/8]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              template<COMPUTECPP_ENABLE_IF(dataType,(!std::is_same< ptr_t, ptr_unqual_t >::value)) >
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< dataType, 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.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [1/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< dataType, asp >::COMPUTECPP_DEPRECATED_BY_SYCL_VER ( 201703  ,
                                                                                                                                                                                                                                              "multi_ptr< dataType, asp >::operator []is no longer available."   
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		inline
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              iIndex.
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Reference to the i-th element the object points to.
                                                                                                                                                                                                                                              Deprecated:
                                                                                                                                                                                                                                              Use operator* or operator-> instead

                                                                                                                                                                                                                                              Definition at line 725 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [2/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< dataType, asp >::COMPUTECPP_DEPRECATED_BY_SYCL_VER ( 201703  ,
                                                                                                                                                                                                                                              "multi_ptr< dataType, asp >::operator []is no longer available."   
                                                                                                                                                                                                                                              ) const
                                                                                                                                                                                                                                              		inline
                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              iIndex.
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Const reference to the i-th element the object points to.
                                                                                                                                                                                                                                              Deprecated:
                                                                                                                                                                                                                                              Use operator* or operator-> instead

                                                                                                                                                                                                                                              Definition at line 735 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator multi_ptr< void_conversion_t, asp >()

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              cl::sycl::multi_ptr< dataType, asp >::operator multi_ptr< void_conversion_t, asp > ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Implicit conversion to multi_ptr<(const) void>.

                                                                                                                                                                                                                                              Const-ness matches value_type.

                                                                                                                                                                                                                                              Definition at line 705 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator*() [1/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              original_type_ref cl::sycl::multi_ptr< dataType, asp >::operator* ( )
                                                                                                                                                                                                                                              		inline
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Reference to the data the object points to.

                                                                                                                                                                                                                                              Definition at line 715 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator*() [2/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              original_type_cref cl::sycl::multi_ptr< dataType, asp >::operator* ( ) const
                                                                                                                                                                                                                                              		inline
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Const reference to the data the object points to.

                                                                                                                                                                                                                                              Definition at line 719 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator+()

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              multi_ptr cl::sycl::multi_ptr< dataType, asp >::operator+ ( difference_type  r) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Creates a new multi_ptr that points r forward compared to *this.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rNumber of elements to increment the underlying pointer by
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              New multi_ptr object with the pointer advanced by r

                                                                                                                                                                                                                                              Definition at line 793 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator++() [1/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              multi_ptr& cl::sycl::multi_ptr< dataType, asp >::operator++ ( )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Increments the underlying pointer by 1.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              This object

                                                                                                                                                                                                                                              Definition at line 747 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator++() [2/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              multi_ptr cl::sycl::multi_ptr< dataType, asp >::operator++ ( int  )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Increments the underlying pointer by 1 and returns a new multi_ptr with the value of the previous pointer.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              New multi_ptr object with the old pointer value

                                                                                                                                                                                                                                              Definition at line 756 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator+=()

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              multi_ptr& cl::sycl::multi_ptr< dataType, asp >::operator+= ( difference_type  r)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Increments the underlying pointer by r.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rNumber of elements to increment the underlying pointer by
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              This object

                                                                                                                                                                                                                                              Definition at line 784 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator-()

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              multi_ptr cl::sycl::multi_ptr< dataType, asp >::operator- ( difference_type  r) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Creates a new multi_ptr that points r backward compared to *this.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rNumber of elements to decrement the underlying pointer by
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              New multi_ptr object with the pointer moved back by r

                                                                                                                                                                                                                                              Definition at line 810 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator--() [1/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              multi_ptr& cl::sycl::multi_ptr< dataType, asp >::operator-- ( )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Decrements the underlying pointer by 1.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              This object

                                                                                                                                                                                                                                              Definition at line 765 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator--() [2/2]

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              multi_ptr cl::sycl::multi_ptr< dataType, asp >::operator-- ( int  )
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Decrements the underlying pointer by 1 and returns a new multi_ptr with the value of the previous pointer.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              New multi_ptr object with the old pointer value

                                                                                                                                                                                                                                              Definition at line 774 of file multi_pointer.h.

                                                                                                                                                                                                                                              ◆ operator-=()

                                                                                                                                                                                                                                              template<typename dataType, cl::sycl::access::address_space asp>
                                                                                                                                                                                                                                              multi_ptr& cl::sycl::multi_ptr< dataType, asp >::operator-= ( difference_type  r)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Decrements the underlying pointer by r.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rNumber of elements to decrement the underlying pointer by
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              This object

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