oneapi::mkl::stats::variation with User-provided Mean#
Description#
Entry point to compute the arrays of variation coefficients with the mean provided by the user.
Mathematical Notation#
Vector of variation coefficients:
\(VC(X) = \left( VC_1(X), \; \dots, VC_p(X) \right), \; VC_i(X) = \frac{V^{0.5}_i(X)}{M_i(X)}\)
Where:
\(i = 1, \dots, p\)
API#
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 std::vector<sycl::event> &dependencies = {});
Include Files#
oneapi/mkl/stats.hpp
Template Parameters#
Name |
Description |
|---|---|
|
Computation method. The specific values are as follows: |
Input Parameters#
Name |
Type |
Description |
|---|---|---|
queue |
|
Valid |
data |
|
Dataset which is used for estimates computation. |
Buffer API
Name |
Type |
Description |
|---|---|---|
mean |
|
sycl::buffer to the array of mean values provided by the user. |
USM API
Name |
Type |
Description |
|---|---|---|
mean |
|
Pointer to the output array of mean values provided by the user. |
Optional Input Parameter for USM API
Name |
Type |
Description |
|---|---|---|
dependencies |
|
List of events to wait for before starting computation, if any. |
Output Parameters#
Buffer API
Name |
Type |
Description |
|---|---|---|
variation |
|
|
USM API
Name |
Type |
Description |
|---|---|---|
variation |
|
Pointer to the output array of variation coefficients. |
event |
|
Function returns event after submitting task in |