.rst .pdf

Contents

oneapi::mkl::stats::raw_moment

Description

Entry point to compute arrays of raw moments up to 4th order.

API

Syntax

Buffer API

template<method Method = method::fast, typename Type, layout ObservationsLayout>
void raw_moment(sycl::queue& queue,
    const dataset<ObservationsLayout, sycl::buffer<Type, 1>>& data,
    sycl::buffer<Type, 1> mean,
    sycl::buffer<Type, 1> raw_moment_2 = {0},
    sycl::buffer<Type, 1> raw_moment_3 = {0},
    sycl::buffer<Type, 1> raw_moment_4 = {0});

USM API

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

Include Files

• oneapi/mkl/stats.hpp

Template Parameters

Name	Description
oneapi::mkl::stats::method Method = oneapi::mkl::stats::method::fast	Computation method. The specific values are as follows: oneapi::mkl::stats::method::fast oneapi::mkl::stats::method::one_pass

Input Parameters

Name	Type	Description
queue	sycl::queue&	Valid sycl::queue, calls of the oneapi::mkl::stats::raw_moment() routine submits kernels in this queue.
data	const dataset<ObservationsLayout, Type*>&	Dataset which is used for estimates computation.

Optional Input Parameters 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
mean	sycl::buffer<Type, 1>	sycl::buffer to the output array of mean values.
raw_moment_2	sycl::buffer<Type, 1>	sycl::buffer to the output array of raw moments of the 2nd order (optional).
raw_moment_3	sycl::buffer<Type, 1>	sycl::buffer to the output array of raw moments of the 3rd order (optional).
raw_moment_4	sycl::buffer<Type, 1>	sycl::buffer to the output array of raw moments of the 4th order (optional).

USM API

Name	Type	Description
mean	Type*	Pointer to the output array of mean values.
raw_moment_2	Type*	Pointer to the output array of raw moments of the 2nd order (optional).
raw_moment_3	Type*	Pointer to the output array of raw moments of the 3rd order (optional).
raw_moment_4	Type*	Pointer to the output array of raw moments of the 4th order (optional).
event	sycl::event	Function returns event after submitting task in sycl::queue.

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