variation with provided mean¶
Entry point to compute variation with the provided mean values.
Description and Assumptions
The oneapi::mkl::stats::variation function is used to compute an array of variation (variation for each dataset’s dimension) with the provided mean values.
variation with provided mean supports the following precisions for data:
T
float
double
oneapi::mkl::stats::variation (buffer version)¶
Syntax
namespace oneapi::mkl::stats {
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> variation);
}
Template Parameters
- Method
Method which is used for estimate computation. The specific values are as follows:
oneapi::mkl::stats::method::fast
- Type
Data precision.
- ObservationsLayout
Data layout. The specific values are described in dataset.
Input Parameters
- queue
The queue where the routine should be executed.
- mean
sycl::buffer to the array of provided mean values.
- 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 mean.get_count() == 0, or dataset object is invalid
variation with provided mean (USM version)¶
Syntax
namespace oneapi::mkl::stats {
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 sycl::vector_class<sycl::event> &dependencies = {});
}
Template Parameters
- Method
Method which is used for estimate computation. The specific values are as follows:
oneapi::mkl::stats::method::fast
- Type
Data precision.
- ObservationsLayout
Data layout. The specific values are described in dataset.
Input Parameters
- queue
The queue where the routine should be executed.
- mean
Pointer to the array of provided mean values.
- 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 the variation values.
Throws
- oneapi::mkl::invalid_argument
Exception is thrown when variation == nullptr, or mean == nullptr, or dataset object is invalid
Return Value
Output event to wait on to ensure computation is complete.
Parent topic: Summary Statistics Routines