oneapi::mkl::stats::max

Description

Entry point to compute the array of maximum values.

API

Syntax

Buffer API

template<method Method = method::fast, typename Type, layout ObservationsLayout>
void max(
    sycl::queue& queue,
    const dataset<ObservationsLayout, sycl::buffer<Type, 1>>& data,
    sycl::buffer<Type, 1> max);

USM API

template<method Method = method::fast, typename Type, layout ObservationsLayout>
sycl::event max(
    sycl::queue& queue,
    const dataset<ObservationsLayout, Type*>& data,
    Type* max,
    const std::vector<sycl::event> &dependencies = {});

Include Files

  • oneapi/mkl/stats.hpp

Template Parameters

oneapi::mkl::stats::method Method = oneapi::mkl::stats::method::fast

Computation method. The specific values are as follows: oneapi::mkl::stats::method::fast

Input Parameters

Name

Type

Description

queue

sycl::queue&

Valid sycl::queue, calls of the oneapi::mkl::stats::max() routine submits kernels in this queue.

data

const dataset<ObservationsLayout, Type*>&

Dataset which is used for estimates computation.

Optional Input Parameter for USM API

Name

Type

Description

dependencies

const std::vector<sycl::event>&

List of events to wait for before starting computation, if any.

Output Parameters

Buffer API

Name

Type

Description

max

sycl::buffer<Type, 1>

sycl::buffer to the output array of maximum values.

USM API

Name

Type

Description

max

Type*

Pointer to the output array of maximum values.

event

sycl::event

Function returns event after submitting task in sycl::queue.