Developer Reference

Contents

oneapi::mkl::stats::central_moment

Description

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

API

Syntax
Buffer API
template<method Method = method::fast, typename Type, layout ObservationsLayout> void central_moment(sycl::queue& queue, const dataset<ObservationsLayout, sycl::buffer<Type, 1>>& data, sycl::buffer<Type, 1> central_moment_2, sycl::buffer<Type, 1> central_moment_3 = {0}, sycl::buffer<Type, 1> central_moment_4 = {0});
USM API
template<method Method = method::fast, typename Type, layout ObservationsLayout> sycl::event central_moment(sycl::queue& queue, const dataset<ObservationsLayout, Type*>& data, Type* central_moment_2, Type* central_moment_3 = nullptr, Type* central_moment_4 = nullptr, 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
oneapi::mkl::stats::method::one_pass
Input Parameters
Name
Type
Description
queue
sycl::queue&
Valid
sycl::queue
, calls of the
oneapi::mkl::stats::central_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
central_moment_2
sycl::buffer<Type, 1>
sycl::buffer
to the output array of central moments of the 2nd order.
central_moment_3
sycl::buffer<Type, 1>
sycl::buffer
to the output array of central moments of the 3rd order (optional).
central_moment_4
sycl::buffer<Type, 1>
sycl::buffer
to the output array of central moments of the 4th order (optional).
USM API
Name
Type
Description
central_moment_2
Type*
Pointer to the output array of central moments of the 2nd order.
central_moment_3
Type*
Pointer to the output array of central moments of the 3rd order (optional).
central_moment_4
Type*
Pointer to the output array of central moments of the 4th order (optional).
event
sycl::event
Function returns event after submitting task in
sycl::queue.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.