.. _oneapi-mkl-stats-variation-with-user-provided-mean:

oneapi::mkl::stats::variation with User-provided Mean
=====================================================

.. contents::
    :local:
    :depth: 1

Description
***********

Entry point to compute the arrays of variation coefficients with the
mean provided by the user.


API
***


Syntax
------

**Buffer API**


.. code-block::

   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**

.. code-block::

   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
-------------------

.. list-table::
   :header-rows: 1

   * -     Name
     -     Description
   * -        \ ``oneapi::mkl::stats::method Method = oneapi::mkl::stats::method::fast``\
     -     Computation method. The specific values are as    follows:      \ ``oneapi::mkl::stats::method::fast``\


Input Parameters
----------------

.. tabularcolumns:: |\Y{0.2}|\Y{0.4}|\Y{0.4}|

.. list-table::
   :header-rows: 1

   * -     Name
     -     Type
     -     Description
   * -     queue
     -     \ ``sycl::queue&``\
     -     Valid ``sycl::queue``, calls of the    ``oneapi::mkl::stats::variation()`` routine submits kernels in this   queue.
   * -     data
     -     \ ``const dataset<ObservationsLayout, Type*>&``\
     -     Dataset which is used for estimates computation.




**Buffer API**


.. list-table::
   :header-rows: 1

   * -     Name
     -     Type
     -     Description
   * -     mean
     -     \ ``sycl::buffer<Type,1>``\
     -     sycl::buffer to the array of mean values provided by the    user.




**USM API**


.. list-table::
   :header-rows: 1

   * -     Name
     -     Type
     -     Description
   * -     mean
     -     \ ``Type*``\
     -     Pointer to the output array of mean values provided by    the user.


**Optional Input Parameter for USM API**


.. list-table::
   :header-rows: 1

   * -     Name
     -     Type
     -     Description
   * -     dependencies
     -     \ ``const std::vector<sycl::event>&``\
     -     List of events to wait for before starting computation,    if any.


Output Parameters
-----------------

**Buffer API**

.. list-table::
   :header-rows: 1

   * -     Name
     -     Type
     -     Description
   * -     variation
     -     \ ``sycl::buffer<Type, 1>``\
     -     \ ``sycl::buffer`` to the output array of variation    coefficients.




**USM API**


.. list-table::
   :header-rows: 1

   * -     Name
     -     Type
     -     Description
   * -     variation
     -     \ ``Type*``\
     -     Pointer to the output array of variation    coefficients.
   * -      event
     -     \ ``sycl::event``\
     -     Function returns event after submitting task in    ``sycl::queue``.