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::stream Class Reference

                                                                                                                                                                                                                                              Class that encapsulates a buffer that can be passed to the device and streamed to. More...

                                                                                                                                                                                                                                              #include <stream.h>

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               stream (size_t bufferSize, size_t maxStatementSize, handler &cgh)
                                                                                                                                                                                                                                               Constructor that takes a buffer size, a max statement size and a handler reference and constructs a stream of the buffer size, associated with the provided handler. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               stream (const stream &)=default
                                                                                                                                                                                                                                               Copy constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               stream (stream &&) noexcept=default
                                                                                                                                                                                                                                               Move constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              stream & operator= (const stream &)=default
                                                                                                                                                                                                                                               Copy assignment operator. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              stream & operator= (stream &&) noexcept=default
                                                                                                                                                                                                                                               Move assignment operator. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               ~stream ()
                                                                                                                                                                                                                                               Destructor, prints the buffer to stdout and resets the buffer. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_size () const
                                                                                                                                                                                                                                               Member function that returns the buffer size. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              size_t get_max_statement_size () const
                                                                                                                                                                                                                                               Inline member function that returns the maximum statement size. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              stream_mode get_stream_mode () const
                                                                                                                                                                                                                                               Inline member function that returns the stream mode. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              int get_precision () const
                                                                                                                                                                                                                                               Inline member function that returns the precision value. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              void set_stream_mode (stream_mode mode)
                                                                                                                                                                                                                                               Inline member function that sets the stream mode. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              void set_precision (int precision)
                                                                                                                                                                                                                                               Inline member function that sets the precision value. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              void set_width (const int width)
                                                                                                                                                                                                                                               Sets the width used when displaying a stream element. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              void append_chars (const char *charBuffer, int size) const
                                                                                                                                                                                                                                               Member function that appends a char buffer to the stream's buffer. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              std::shared_ptr< cl::sycl::storage_mem > get_buffer () const
                                                                                                                                                                                                                                               Member function that returns a shared_ptr to the detail buffer object. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

                                                                                                                                                                                                                                              COMPUTECPP_EXPORT std::ostream & operator<< (std::ostream &out, const stream &rhs)
                                                                                                                                                                                                                                               Friend function declaration to give global stream operator access to private members. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool operator== (const stream &lhs, const stream &rhs)
                                                                                                                                                                                                                                               Determines if lhs and rhs are equal. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool operator!= (const stream &lhs, const stream &rhs)
                                                                                                                                                                                                                                               Determines if lhs and rhs are not equal. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              Class that encapsulates a buffer that can be passed to the device and streamed to.

                                                                                                                                                                                                                                              Used for debugging. Host only.

                                                                                                                                                                                                                                              Definition at line 276 of file stream.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ stream() [1/3]

                                                                                                                                                                                                                                              cl::sycl::stream::stream ( size_t  bufferSize,
                                                                                                                                                                                                                                              size_t  maxStatementSize,
                                                                                                                                                                                                                                              handler &  cgh 
                                                                                                                                                                                                                                              )

                                                                                                                                                                                                                                              Constructor that takes a buffer size, a max statement size and a handler reference and constructs a stream of the buffer size, associated with the provided handler.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              bufferSizeThe size of the stream's buffer.
                                                                                                                                                                                                                                              maxStatementSizeThe maximum size of a single statement in the stream's buffer.
                                                                                                                                                                                                                                              cghA reference to the handler that the stream is to be associated with.

                                                                                                                                                                                                                                              ◆ stream() [2/3]

                                                                                                                                                                                                                                              cl::sycl::stream::stream ( const stream &  )
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Copy constructor.

                                                                                                                                                                                                                                              ◆ stream() [3/3]

                                                                                                                                                                                                                                              cl::sycl::stream::stream ( stream &&  )
                                                                                                                                                                                                                                              		defaultnoexcept

                                                                                                                                                                                                                                              Move constructor.

                                                                                                                                                                                                                                              ◆ ~stream()

                                                                                                                                                                                                                                              cl::sycl::stream::~stream ( )

                                                                                                                                                                                                                                              Destructor, prints the buffer to stdout and resets the buffer.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ append_chars()

                                                                                                                                                                                                                                              void cl::sycl::stream::append_chars ( const char *  charBuffer,
                                                                                                                                                                                                                                              int  size 
                                                                                                                                                                                                                                              ) const

                                                                                                                                                                                                                                              Member function that appends a char buffer to the stream's buffer.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              charBufferThe char buffer to be appended. The size of the char buffer to be appended.

                                                                                                                                                                                                                                              ◆ get_buffer()

                                                                                                                                                                                                                                              std::shared_ptr<cl::sycl::storage_mem> cl::sycl::stream::get_buffer ( ) const

                                                                                                                                                                                                                                              Member function that returns a shared_ptr to the detail buffer object.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              A shared_ptr to the detail buffer object.

                                                                                                                                                                                                                                              ◆ get_max_statement_size()

                                                                                                                                                                                                                                              size_t cl::sycl::stream::get_max_statement_size ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Inline member function that returns the maximum statement size.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              THe maximum statement size.

                                                                                                                                                                                                                                              Definition at line 357 of file stream.h.

                                                                                                                                                                                                                                              ◆ get_precision()

                                                                                                                                                                                                                                              int cl::sycl::stream::get_precision ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Inline member function that returns the precision value.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The precision value.

                                                                                                                                                                                                                                              Definition at line 371 of file stream.h.

                                                                                                                                                                                                                                              ◆ get_size()

                                                                                                                                                                                                                                              size_t cl::sycl::stream::get_size ( ) const

                                                                                                                                                                                                                                              Member function that returns the buffer size.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The buffer size.

                                                                                                                                                                                                                                              ◆ get_stream_mode()

                                                                                                                                                                                                                                              stream_mode cl::sycl::stream::get_stream_mode ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Inline member function that returns the stream mode.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The stream mode.

                                                                                                                                                                                                                                              Definition at line 365 of file stream.h.

                                                                                                                                                                                                                                              ◆ operator=() [1/2]

                                                                                                                                                                                                                                              stream& cl::sycl::stream::operator= ( const stream &  )
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Copy assignment operator.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Reference to this object

                                                                                                                                                                                                                                              ◆ operator=() [2/2]

                                                                                                                                                                                                                                              stream& cl::sycl::stream::operator= ( stream &&  )
                                                                                                                                                                                                                                              		defaultnoexcept

                                                                                                                                                                                                                                              Move assignment operator.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Reference to this object

                                                                                                                                                                                                                                              ◆ set_precision()

                                                                                                                                                                                                                                              void cl::sycl::stream::set_precision ( int  precision)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Inline member function that sets the precision value.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              precisionThe precision value to set.

                                                                                                                                                                                                                                              Definition at line 385 of file stream.h.

                                                                                                                                                                                                                                              ◆ set_stream_mode()

                                                                                                                                                                                                                                              void cl::sycl::stream::set_stream_mode ( stream_mode  mode)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Inline member function that sets the stream mode.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              modeThe stream mode to set.

                                                                                                                                                                                                                                              Definition at line 377 of file stream.h.

                                                                                                                                                                                                                                              ◆ set_width()

                                                                                                                                                                                                                                              void cl::sycl::stream::set_width ( const int  width)
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Sets the width used when displaying a stream element.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              widthDesired width

                                                                                                                                                                                                                                              Definition at line 392 of file stream.h.

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ operator!=

                                                                                                                                                                                                                                              bool operator!= ( const stream &  lhs,
                                                                                                                                                                                                                                              const stream &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Determines if lhs and rhs are not equal.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              lhsLeft-hand-side object in comparison
                                                                                                                                                                                                                                              rhsRight-hand-side object in comparison
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if different underlying objects

                                                                                                                                                                                                                                              Definition at line 329 of file stream.h.

                                                                                                                                                                                                                                              ◆ operator<<

                                                                                                                                                                                                                                              COMPUTECPP_EXPORT std::ostream& operator<< ( std::ostream &  out,
                                                                                                                                                                                                                                              const stream &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Friend function declaration to give global stream operator access to private members.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              outThe output stream.
                                                                                                                                                                                                                                              rhsThe stream object to be streamed into the output.

                                                                                                                                                                                                                                              ◆ operator==

                                                                                                                                                                                                                                              bool operator== ( const stream &  lhs,
                                                                                                                                                                                                                                              const stream &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Determines if lhs and rhs are equal.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              lhsLeft-hand-side object in comparison
                                                                                                                                                                                                                                              rhsRight-hand-side object in comparison
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if same underlying object

                                                                                                                                                                                                                                              Definition at line 320 of file stream.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.