Skip to content

Latest commit

 

History

History
executable file
·
152 lines (93 loc) · 3.39 KB

onemkl_stats_variation.rst

File metadata and controls

executable file
·
152 lines (93 loc) · 3.39 KB
Raw

variation

Entry point to compute variation.

Description and Assumptions

The oneapi::mkl::stats::variation function is used to compute a variation array (variation for each dataset's dimension).

:ref:`onemkl_stats_variation` supports the following precisions for data:

T
float
double

variation (buffer version)

Syntax

namespace oneapi::mkl::stats {
template<method Method = method::fast, typename Type, layout ObservationsLayout>
    void variation(sycl::queue& queue,
    const dataset<ObservationsLayout, sycl::buffer<Type, 1>>& data,
    sycl::buffer<Type, 1> variation);
}

Template Parameters

Method

Method which is used for estimate computation. The specific values are as follows:

  • oneapi::mkl::stats::method::fast
  • oneapi::mkl::stats::method::one_pass
Type
Data precision.
ObservationsLayout
Data layout. The specific values are described in :ref:`onemkl_stats_dataset`.

Input Parameters

queue
The queue where the routine should be executed.
data
Dataset which is used for computation.

Output Parameters

variation
sycl::buffer array of variation values.

Throws

oneapi::mkl::invalid_argument
Exception is thrown when variation.get_count() == 0, or dataset object is invalid

variation (USM version)

Syntax

namespace oneapi::mkl::stats {
template<method Method = method::fast, typename Type, layout ObservationsLayout>
    sycl::event variation(sycl::queue& queue,
    const dataset<ObservationsLayout, Type*>& data,
    Type* variation,
    const std::vector<sycl::event> &dependencies = {});
}

Template Parameters

Method

Method which is used for estimate computation. The specific values are as follows:

  • oneapi::mkl::stats::method::fast
  • oneapi::mkl::stats::method::one_pass
Type
Data precision.
ObservationsLayout
Data layout. The specific values are described in :ref:`onemkl_stats_dataset`.

Input Parameters

queue
The queue where the routine should be executed.
data
Dataset which is used for computation.
dependencies
Optional parameter. List of events to wait for before starting computation, if any.

Output Parameters

variation
Pointer to the array of variation values.

Throws

oneapi::mkl::invalid_argument
Exception is thrown when variation == nullptr, or dataset object is invalid

Return Value

Output event to wait on to ensure computation is complete.

Parent topic: :ref:`onemkl_stats_routines`