oneapi::mkl::stats::central

Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 12/16/2022

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-F86A7DEA-203A-4133-A66E-22BB857B639E

View Details

Description

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

API

Syntax

Buffer API

template<method Method = method::fast, typename Type, layout ObservationsLayout>
void central_sum(sycl::queue& queue,
    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,
    const dataset<ObservationsLayout, Type*>& data,
    Type* central_sum_2,
    Type* central_sum_3 = nullptr,
    Type* central_sum_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::fastoneapi::mkl::stats::method::one_pass

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.

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_sum_2	`sycl::buffer<Type, 1>`	`sycl::buffer` to the output array of central sums of the 2nd order (optional).
central_sum_3	`sycl::buffer<Type, 1>`	`sycl::buffer` to the output array of central sums of the 3rd order (optional).
central_sum_4	`sycl::buffer<Type, 1>`	`sycl::buffer` to the output array of central sums of the 4th order (optional).

USM API

Name	Type	Description
central_sum_2	`Type*`	Pointer to the output array of central sums of the 2nd order (optional).
central_sum_3	`Type*`	Pointer to the output array of central sums of the 3rd order (optional).
central_sum_4	`Type*`	Pointer to the output array of central sums of the 4th order (optional).
event	`sycl::event`	Function returns event after submitting task in `sycl::queue.`

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

oneapi::mkl::stats::central_sum

Description

API