.. _cdfnorm:

cdfnorm
=======


Computes the element-wise cumulative normal distribution function of vector elements.


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

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

The ``cdfnorm`` function computes the cumulative normal distribution
function values for elements of the input vector ``a`` and writes
them to the output vector ``y``.


The cumulative normal distribution function is defined as given by:

.. math::

   \mathrm{CdfNorm} (x) = \frac{1}{\sqrt{2\pi}} \int_{-\infty}^x e^{-t^2}dt


Useful relations:


.. math::

   \mathrm{cdfnorm} (x) =
   \frac{1}{2}
   (1 + \mathrm{erf} (\frac{x}{\sqrt{2}})) =
   1 - frac{1}{2} \mathrm{erfc} (\frac{x}{\sqrt{2}})


where ``erf`` and ``erfc`` are the error and complementary error functions.


The following figure illustrates the relationships among ``erf`` family
functions (``erf``, ``erfc``, ``cdfnorm``).

.. figure:: /_figures/GUID-0B9A59CC-C914-429D-AF87-93B16DABD291-low.jpg
   :align: center
   :alt: cdfnorm Family Functions Relationship

   ``cdfnorm`` Family Functions Relationship



Useful relations for these functions:

.. math::

   \mathrm{erf} (x) + \mathrm{erfc} = 1


.. math::

   \mathrm{cdfnorm} (x) =
   \frac{1}{2}
   (1 + \mathrm{erf} (\frac{x}{\sqrt{2}})) =
   1 - frac{1}{2} \mathrm{erfc} (\frac{x}{\sqrt{2}})



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

   * -  Argument
     -  Result
     -  Error Code
   * -  a < underflow
     -  +0
     -  ``status::underflow``
   * -  +\ :math:`\infty`
     -  +1
     -
   * -  -\ :math:`\infty`
     -  +0
     -
   * -  QNAN
     -  QNAN
     -
   * -  SNAN
     -  QNAN
     -


API
***


Syntax
------

**Buffer API**


.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event cdfnorm(sycl::queue & exec_queue,
         std::int64_t n,
         sycl::buffer<T> & a,
         sycl::buffer<T> & y,
         oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
         oneapi::mkl::vm::error_handler<T> errhandler = {});

   }

.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event cdfnorm(sycl::queue & exec_queue,
         sycl::buffer<T> & a,
         oneapi::mkl::slice sa,
         sycl::buffer<T> & y,
         oneapi::mkl::slice sy,
         oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
         oneapi::mkl::vm::error_handler<T> errhandler = {});

   }

**USM API**

.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event cdfnorm(sycl::queue & exec_queue,
         std::int64_t n,
         T const * a,
         T * y,
         std::vector<cl::sycl::event> const & depends = {},
         oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
         oneapi::mkl::vm::error_handler<T> errhandler = {});

   }

.. code-block:: cpp

   namespace oneapi::mkl::vm {

   sycl::event cdfnorm(sycl::queue & exec_queue,
         T const * a,
         oneapi::mkl::slice sa,
         T * y,
         oneapi::mkl::slice sy,
         std::vector<cl::sycl::event> const & depends = {},
         oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
         oneapi::mkl::vm::error_handler<T> errhandler = {});

   }




``cdfnorm`` supports the following precisions and devices:

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

   * -  T
     -  Devices supported
   * -  ``float``
     -  Host, CPU, and GPU
   * -  ``double``
     -  Host, CPU, and GPU


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

**Buffer API**


exec_queue
   The queue where the routine should be executed.


n
   Specifies the number of elements to be calculated.


a
   The buffer containing the input vector.


sa
   Slice selector for ``a``. See :ref:`data-types` for a description of the |O-MKL| slice type.


sy
   Slice selector for ``y``. See :ref:`data-types` for a description of the |O-MKL| slice type.


mode
   Overrides the global VM mode setting for this function call. See :ref:`set_mode` function for possible values and their description. This is an optional parameter. The default value is ``mode::not_defined``.


errhandler
   Sets local error handling mode for this function call. See the :ref:`create_error_handler` function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.


**USM API**


exec_queue
   The queue where the routine should be executed.


n
   Specifies the number of elements to be calculated.


a
   Pointer to the input vector.


sa
   Slice selector for ``a``. See :ref:`data-types` for a description of the |O-MKL| slice type.


sy
   Slice selector for ``y``. See :ref:`data-types` for a description of the |O-MKL| slice type.


depends
   Vector of dependent events (to wait for input data to be ready). This is an optional parameter. The default is an empty vector.


mode
   Overrides the global VM mode setting for this function call. See the :ref:`set_mode` function for possible values and their description. This is an optional parameter. The default value is ``mode::not_defined``.


errhandler
   Sets local error handling mode for this function call. See the :ref:`create_error_handler` function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.


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

**Buffer API**


y
   The buffer containing the output vector.


return value (event)
   Computation end event.


**USM API**


y
   Pointer to the output vector.


return value (event)
   Computation end event.


Examples
********

An example of how to use ``cdfnorm`` can be found in the |O-MKL|
installation directory, under:


.. code-block::

   examples/dpcpp/vml/source/vcdfnorm.cpp