dpctl.program.SyclKernel

class dpctl.program.SyclKernel

Attributes:

`compile_num_sub_groups`	Returns the number of sub-groups specified by this kernel, or 0 (if not specified).
`compile_sub_group_size`	Returns the required sub-group size specified by this kernel, or 0 (if not specified).
`max_num_sub_groups`	Returns the maximum number of sub-groups for this kernel.
`max_sub_group_size`	Returns the maximum sub-groups size for this kernel.
`num_args`	Property equivalent to method call SyclKernel.get_num_args()
`preferred_work_group_size_multiple`	Returns a value, of which work-group size is preferred to be a multiple, for executing the kernel on the device it was built for.
`private_mem_size`	Returns the minimum amount of private memory, in bytes, used by each work-item in the kernel.
`work_group_size`	Returns the maximum number of work-items in a work-group that can be used to execute the kernel on device it was built for.

Public methods:

`addressof_ref`()	Returns the address of the C API `DPCTLSyclKernelRef` pointer as a `size_t`.
`get_function_name`()	Returns the name of the `sycl::kernel` function.
`get_num_args`()	Returns the number of arguments for this kernel function.

Attributes

SyclKernel.compile_num_sub_groups: Returns the number of sub-groups specified by this kernel, or 0 (if not specified).

SyclKernel.compile_sub_group_size: Returns the required sub-group size specified by this kernel, or 0 (if not specified).

SyclKernel.max_num_sub_groups: Returns the maximum number of sub-groups for this kernel.

SyclKernel.max_sub_group_size: Returns the maximum sub-groups size for this kernel.

SyclKernel.num_args: Property equivalent to method call SyclKernel.get_num_args()

SyclKernel.preferred_work_group_size_multiple: Returns a value, of which work-group size is preferred to be a multiple, for executing the kernel on the device it was built for.

SyclKernel.private_mem_size: Returns the minimum amount of private memory, in bytes, used by each work-item in the kernel.

SyclKernel.work_group_size: Returns the maximum number of work-items in a work-group that can be used to execute the kernel on device it was built for.

dpctl.program.SyclKernel.addressof_ref(self)

Returns the address of the C API DPCTLSyclKernelRef pointer as a size_t.

Returns:: The address of the DPCTLSyclKernelRef pointer used to create this dpctl.SyclKernel object cast to a size_t.

dpctl.program.SyclKernel.get_function_name(self): Returns the name of the sycl::kernel function.

dpctl.program.SyclKernel.get_num_args(self): Returns the number of arguments for this kernel function.