oneapi::mkl::stats::variation with User-provided Mean

Entry point to compute the arrays of variation coefficients with the mean provided by the user.

Syntax

Buffer API

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

USM API

template<method Method = method::fast, typename Type, layout ObservationsLayout>
sycl::event variation(sycl::queue& queue,
    Type* mean,
    const dataset<ObservationsLayout, Type*>& data,
    Type* variation,
    const sycl::vector_class<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::variation() routine submits kernels in this queue.

data

const dataset<ObservationsLayout, Type*>&

Dataset which is used for estimates computation.

Buffer API

Name

Type

Description

mean

sycl::buffer<Type,1>

sycl::buffer to the array of mean values provided by the user.

USM API

Name

Type

Description

mean

Type*

Pointer to the output array of mean values provided by the user.

Optional Input Parameter for USM API

Name

Type

Description

dependencies

const sycl::vector_class<sycl::event>&

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

Output Parameters

Buffer API

Name

Type

Description

variation

sycl::buffer<Type, 1>

sycl::buffer to the output array of variation coefficients.

USM API

Name

Type

Description

variation

Type*

Pointer to the output array of variation coefficients.

event

sycl::event

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