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

Entry point to compute arrays of central sums up to the 4th order with mean provided by the user.

Syntax

Buffer API

template<method Method = method::fast, typename Type, layout ObservationsLayout>
void central_sum(sycl::queue& queue,
    sycl::buffer<Type, 1> mean,
    const dataset<ObservationsLayout, sycl::buffer<Type, 1>>& data,
    sycl::buffer<Type, 1> central_sum_2,
    sycl::buffer<Type, 1> central_sum_3 = {0},
    sycl::buffer<Type, 1> central_sum_4 = {0});

USM API

template<method Method = method::fast, typename Type, layout ObservationsLayout>
sycl::event central_sum(sycl::queue& queue,
    Type* mean,
    const dataset<ObservationsLayout, Type*>& data,
    Type* central_sum_2,
    Type* central_sum_3 = nullptr,
    Type* central_sum_4 = nullptr,
    const sycl::vector_class<sycl::event> &dependencies = {});;

Include Files

  • oneapi/mkl/stats.hpp

Template Parameters

Input Parameters

Name

Type

Description

queue

sycl::queue&

Valid sycl::queue, calls of the oneapi::mkl::stats::central_sum() 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.

Output Parameters

Buffer API

Name

Type

Description

central_sum_2

sycl::buffer<Type, 1>

sycl::buffer to the output array of central sums of the 2nd order.

central_sum_3

sycl::buffer<Type, 1>

sycl::buffer to the output array of central sums of the 3rd order.

central_sum_4

sycl::buffer<Type, 1>

sycl::buffer to the output array of central sums of the 4th order.

USM API

Name

Type

Description

central_sum_2

Type*

Pointer to the output array of central sums of the 2nd order.

central_sum_3

Type*

Pointer to the output array of central sums of the 3rd order.

central_sum_4

Type*

Pointer to the output array of central sums of the 4th order.

event

sycl::event

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