[onemKL] add BLAS APIs.

source/elements/oneMKL/source/domains/blas/axpby.rst

@@ -0,0 +1,214 @@
+.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. _onemkl_blas_axpby:
+
+axpby
+=====
+
+Computes a vector-scalar product added to a scaled-vector.
+
+.. _onemkl_blas_axpby_description:
+
+.. rubric:: Description
+
+The ``axpby`` routines compute two scalar-vector product and add them:
+
+.. math::
+
+      y \leftarrow beta * y + alpha * x
+
+where ``x`` and ``y`` are vectors of ``n`` elements and ``alpha`` and ``beta`` are scalars.
+
+``axpby`` supports the following precisions.
+
+   .. list-table::
+      :header-rows: 1
+
+      * -  T
+      * -  ``float``
+      * -  ``double``
+      * -  ``std::complex<float>``
+      * -  ``std::complex<double>``
+
+.. _onemkl_blas_axpby_buffer:
+
+axpby (Buffer Version)
+----------------------
+
+.. rubric:: Syntax
+
+.. code-block:: cpp
+
+   namespace oneapi::mkl::blas::column_major {
+       void axpby(sycl::queue &queue,
+                 std::int64_t n,
+                 T alpha,
+                 sycl::buffer<T,1> &x, std::int64_t incx,
+                 T beta,
+                 sycl::buffer<T,1> &y, std::int64_t incy)
+   }
+.. code-block:: cpp
+
+   namespace oneapi::mkl::blas::row_major {
+       void axpby(sycl::queue &queue,
+                 std::int64_t n,
+                 T alpha,
+                 sycl::buffer<T,1> &x, std::int64_t incx,
+                 T beta,
+                 sycl::buffer<T,1> &y, std::int64_t incy)
+   }
+
+.. container:: section
+
+   .. rubric:: Input Parameters
+
+   queue
+      The queue where the routine should be executed.
+
+   n
+      Number of elements in vector ``x`` and ``y``.
+
+   alpha
+      Specifies the scalar ``alpha``.
+
+   x
+      Buffer holding input vector ``x``. The buffer must be of size at least
+      (1 + (``n`` – 1)*abs(``incx``)). See :ref:`matrix-storage` for
+      more details.
+
+   incx
+      Stride between two consecutive elements of the ``x`` vector.
+
+   beta
+      Specifies the scalar ``beta``.
+
+   y
+      Buffer holding input vector ``y``. The buffer must be of size at least
+      (1 + (``n`` – 1)*abs(``incy``)). See :ref:`matrix-storage` for
+      more details.
+
+   incy
+      Stride between two consecutive elements of the ``y`` vector.
+
+.. container:: section
+
+   .. rubric:: Output Parameters
+
+   y
+      Buffer holding the updated vector ``y``.
+
+.. container:: section
+
+   .. rubric:: Throws
+
+   This routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here.
+
+   :ref:`oneapi::mkl::invalid_argument<onemkl_exception_invalid_argument>`
+
+   :ref:`oneapi::mkl::unsupported_device<onemkl_exception_unsupported_device>`
+
+   :ref:`oneapi::mkl::host_bad_alloc<onemkl_exception_host_bad_alloc>`
+
+   :ref:`oneapi::mkl::device_bad_alloc<onemkl_exception_device_bad_alloc>`
+
+   :ref:`oneapi::mkl::unimplemented<onemkl_exception_unimplemented>`
+
+.. _onemkl_blas_axpby_usm:
+
+axpby (USM Version)
+-------------------
+
+.. rubric:: Syntax
+
+.. code-block:: cpp
+
+   namespace oneapi::mkl::blas::column_major {
+       sycl::event axpby(sycl::queue &queue,
+                        std::int64_t n,
+                        T alpha,
+                        const T *x, std::int64_t incx,
+                        const T beta,
+                        T *y, std::int64_t incy,
+                        const std::vector<sycl::event> &dependencies = {})
+   }
+.. code-block:: cpp
+
+   namespace oneapi::mkl::blas::row_major {
+       sycl::event axpby(sycl::queue &queue,
+                        std::int64_t n,
+                        T alpha,
+                        const T *x, std::int64_t incx,
+                        const T beta,
+                        T *y, std::int64_t incy,
+                        const std::vector<sycl::event> &dependencies = {})
+   }
+
+.. container:: section
+
+   .. rubric:: Input Parameters
+
+   queue
+      The queue where the routine should be executed.
+
+   n
+      Number of elements in vector ``x`` and ``y``.
+
+   alpha
+      Specifies the scalar alpha.
+
+   beta
+      Specifies the scalar beta.
+
+   x
+      Pointer to the input vector ``x``. The allocated memory must be
+      of size at least (1 + (``n`` – 1)*abs(``incx``)). See
+      :ref:`matrix-storage` for more details.
+
+   incx
+      Stride between consecutive elements of the ``x`` vector.
+
+   y
+      Pointer to the input vector ``y``. The allocated memory must be
+      of size at least (1 + (``n`` – 1)*abs(``incy``)). See
+      :ref:`matrix-storage` for more details.
+
+   incy
+      Stride between consecutive elements of the ``y`` vector.
+
+   dependencies
+      List of events to wait for before starting computation, if any.
+      If omitted, defaults to no dependencies.
+
+.. container:: section
+
+   .. rubric:: Output Parameters
+
+   y
+      Array holding the updated vector ``y``.
+
+.. container:: section
+
+   .. rubric:: Return Values
+
+   Output event to wait on to ensure computation is complete.
+
+.. container:: section
+
+   .. rubric:: Throws
+
+   This routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here.
+
+   :ref:`oneapi::mkl::invalid_argument<onemkl_exception_invalid_argument>`
+
+   :ref:`oneapi::mkl::unsupported_device<onemkl_exception_unsupported_device>`
+
+   :ref:`oneapi::mkl::host_bad_alloc<onemkl_exception_host_bad_alloc>`
+
+   :ref:`oneapi::mkl::device_bad_alloc<onemkl_exception_device_bad_alloc>`
+
+   :ref:`oneapi::mkl::unimplemented<onemkl_exception_unimplemented>`
+
+   **Parent topic:** :ref:`blas-like-extensions`
+

source/elements/oneMKL/source/domains/blas/axpy_batch.rst

@@ -244,15 +244,15 @@ The total number of vectors in ``x`` and ``y`` are given by the ``batch_size`` p
 
    x
       Array of pointers to input vectors ``X`` with size ``total_batch_count``.
-      The size of array allocated for the ``X`` vector of the group ``i`` must be at least (1 + (``n[i]`` – 1)*abs(``incx[i]``))``. 
+      The size of array allocated for the ``X`` vector of the group ``i`` must be at least (1 + (``n[i]`` – 1)*abs(``incx[i]``)). 
       See :ref:`matrix-storage` for more details.
 
    incx
       Array of ``group_count`` integers. ``incx[i]`` specifies the stride of vector ``X`` in group ``i``.
 
    y
       Array of pointers to input/output vectors ``Y`` with size ``total_batch_count``.
-      The size of array allocated for the ``Y`` vector of the group ``i`` must be at least (1 + (``n[i]`` – 1)*abs(``incy[i]``))``. 
+      The size of array allocated for the ``Y`` vector of the group ``i`` must be at least (1 + (``n[i]`` – 1)*abs(``incy[i]``)). 
       See :ref:`matrix-storage` for more details.
 
    incy

source/elements/oneMKL/source/domains/blas/blas-like-extensions.rst

@@ -46,7 +46,12 @@ BLAS-like Extensions
     :hidden:
 
     axpy_batch
+    axpby
+    copy_batch
+    dgmm_batch
     gemm_batch
+    gemv_batch
+    syrk_batch
     trsm_batch
     gemmt
     gemm_bias