[oneMKL][BLAS] make incx, incy argument descriptions in Level 2 BLAS consistent (#474)

Author: andrewtbarker

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

@@ -105,19 +105,19 @@ where:
       Buffer holding input vectors ``X`` with size ``stridex`` * ``batch_size``.
 
    incx 
-      Stride of vector ``X``.
+      Stride of vector ``X``. Must not be zero.
 
    stridex 
-      Stride between different ``X`` vectors.
+      Stride between different ``X`` vectors. Must be at least zero.
 
    y
       Buffer holding input/output vectors ``Y`` with size ``stridey`` * ``batch_size``.
 
    incy 
-      Stride of vector ``Y``.
+      Stride of vector ``Y``. Must not be zero.
 
    stridey 
-      Stride between different ``Y`` vectors.
+      Stride between different ``Y`` vectors. Must be at least (1 + (``n``-1)*abs(``incy``)).
 
    batch_size 
       Specifies the number of ``axpy`` operations to perform.
@@ -248,15 +248,15 @@ The total number of vectors in ``x`` and ``y`` are given by the ``batch_size`` p
       See :ref:`matrix-storage` for more details.
 
    incx
-      Array of ``group_count`` integers. ``incx[i]`` specifies the stride of vector ``X`` in group ``i``.
+      Array of ``group_count`` integers. ``incx[i]`` specifies the stride of vector ``X`` in group ``i``. Must not be zero.
 
    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]``)). 
       See :ref:`matrix-storage` for more details.
 
    incy
-      Array of ``group_count`` integers. ``incy[i]`` specifies the stride of vector ``Y`` in group ``i``.
+      Array of ``group_count`` integers. ``incy[i]`` specifies the stride of vector ``Y`` in group ``i``. Must not be zero.
 
    group_count
       Number of groups. Must be at least 0.
@@ -335,19 +335,19 @@ The total number of vectors in ``x`` and ``y`` are given by the ``batch_size`` p
       Pointer to input vectors ``X`` with size ``stridex`` * ``batch_size``.
 
    incx 
-      Stride of vector ``X``.
+      Stride of vector ``X``. Must not be zero.
 
    stridex 
-      Stride between different ``X`` vectors.
+      Stride between different ``X`` vectors. Must be at least zero.
 
    y
       Pointer to input/output vectors ``Y`` with size ``stridey`` * ``batch_size``.
 
    incy 
-      Stride of vector ``Y``.
+      Stride of vector ``Y``. Must not be zero.
 
    stridey 
-      Stride between different ``Y`` vectors.
+      Stride between different ``Y`` vectors. Must be at least (1 + (``n``-1)*abs(``incy``)).
 
    batch_size 
       Specifies the number of ``axpy`` operations to perform.

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

@@ -98,19 +98,19 @@ where:
       Buffer holding input vectors ``X`` with size ``stridex`` * ``batch_size``.
 
    incx 
-      Stride of vector ``X``.
+      Stride of vector ``X``. Must not be zero.
 
    stridex 
-      Stride between different ``X`` vectors.
+      Stride between different ``X`` vectors. Must be at least zero.
 
    y
       Buffer holding input/output vectors ``Y`` with size ``stridey`` * ``batch_size``.
 
    incy 
-      Stride of vector ``Y``.
+      Stride of vector ``Y``. Must not be zero.
 
    stridey 
-      Stride between different ``Y`` vectors.
+      Stride between different ``Y`` vectors. Must be at least (1 + (``n``-1)*abs(``incy``)).
 
    batch_size 
       Specifies the number of ``copy`` operations to perform.
@@ -233,15 +233,15 @@ The total number of vectors in ``x`` and ``y`` are given by the ``batch_size`` p
       See :ref:`matrix-storage` for more details.
 
    incx
-      Array of ``group_count`` integers. ``incx[i]`` specifies the stride of vector ``X`` in group ``i``.
+      Array of ``group_count`` integers. ``incx[i]`` specifies the stride of vector ``X`` in group ``i``. Must not be zero.
 
    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]``)). 
       See :ref:`matrix-storage` for more details.
 
    incy
-      Array of ``group_count`` integers. ``incy[i]`` specifies the stride of vector ``Y`` in group ``i``.
+      Array of ``group_count`` integers. ``incy[i]`` specifies the stride of vector ``Y`` in group ``i``. Must not be zero.
 
    group_count
       Number of groups. Must be at least 0.
@@ -314,19 +314,19 @@ The total number of vectors in ``x`` and ``y`` are given by the ``batch_size`` p
       Pointer to input vectors ``X`` with size ``stridex`` * ``batch_size``.
 
    incx 
-      Stride of vector ``X``.
+      Stride of vector ``X``. Must not be zero.
 
    stridex 
-      Stride between different ``X`` vectors.
+      Stride between different ``X`` vectors. Must be at least zero.
 
    y
       Pointer to input/output vectors ``Y`` with size ``stridey`` * ``batch_size``.
 
    incy 
-      Stride of vector ``Y``.
+      Stride of vector ``Y``. Must not be zero.
 
    stridey 
-      Stride between different ``Y`` vectors.
+      Stride between different ``Y`` vectors. Must be at least (1 + (``n``-1)*abs(``incy``)).
 
    batch_size 
       Specifies the number of ``copy`` operations to perform.

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

@@ -135,7 +135,7 @@ gbmv (Buffer Version)
       more details.
 
    incx
-      Stride of vector ``x``.
+      Stride of vector ``x``. Must not be zero.
 
    beta
       Scaling factor for vector ``y``.
@@ -273,7 +273,7 @@ gbmv (USM Version)
       :ref:`matrix-storage` for more details.
 
    incx
-      Stride of vector ``x``.
+      Stride of vector ``x``. Must not be zero.
 
    beta
       Scaling factor for vector ``y``.

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

@@ -120,7 +120,7 @@ gemv (Buffer Version)
       1)*abs(``incx``)). See :ref:`matrix-storage` for more details.
 
    incx
-      The stride of vector ``x``.
+      The stride of vector ``x``. Must not be zero.
 
    beta
       The scaling factor for vector ``y``.
@@ -133,7 +133,7 @@ gemv (Buffer Version)
       :ref:`matrix-storage` for more details.
 
    incy
-      The stride of vector ``y``.
+      The stride of vector ``y``. Must not be zero.
 
 .. container:: section
 
@@ -248,7 +248,7 @@ gemv (USM Version)
       more details.
 
    incx
-      The stride of vector ``x``.
+      The stride of vector ``x``. Must not be zero.
 
    beta
       The scaling factor for vector ``y``.
@@ -262,7 +262,7 @@ gemv (USM Version)
       more details.
 
    incy
-      The stride of vector ``y``.
+      The stride of vector ``y``. Must not be zero.
 
    dependencies
       List of events to wait for before starting computation, if any.

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

@@ -134,13 +134,13 @@ parameter.
       ``n`` if row major layout is used.
 
    stridea
-      Stride between different ``A`` matrices.
+      Stride between different ``A`` matrices. Must be at least zero.
 
    x
       Buffer holding the input vectors ``X`` with size ``stridex`` * ``batch_size``.
 
    incx
-      The stride of the vector ``X``. It must be positive.
+      The stride of the vector ``X``.  Must not be zero.
 
    stridex
       Stride between different consecutive ``X`` vectors, must be at least 0.
@@ -152,12 +152,10 @@ parameter.
       Buffer holding input/output vectors ``Y`` with size ``stridey`` * ``batch_size``.
 
    incy
-      Stride between two consecutive elements of the ``y`` vectors.
+      Stride between two consecutive elements of the ``Y`` vectors. Must not be zero.
 
    stridey
-      Stride between two consecutive ``Y`` vectors. Must be at least
-      (1 + (len-1)*abs(incy)) where ``len`` is ``m`` if the matrix ``A``
-      is non transpose or ``n`` otherwise.
+      Stride between two consecutive ``Y`` vectors. Must be at least (1 + (``m`` - 1)*abs(``incy``)) if layout is column major or (1 + (``n`` - 1)*abs(``incy``)) if row major layout is used.
 
    batch_size
       Specifies the number of matrix-vector operations to perform.
@@ -328,8 +326,8 @@ total number of vectors in ``x`` and ``y`` and matrices in ``A`` are given by th
 
    incx
       Array of ``group_count`` integers. ``incx[i]`` specifies the
-      stride of ``X`` for every vector in group ``i``. All
-      entries must be positive.
+      stride of ``X`` for every vector in group ``i``. Must not
+      be zero.
 
    beta
       Array of ``group_count`` scalar elements. ``beta[i]`` specifies
@@ -343,10 +341,8 @@ total number of vectors in ``x`` and ``y`` and matrices in ``A`` are given by th
 
    incy
       Array of ``group_count`` integers. ``incy[i]`` specifies the
-      leading dimension of ``Y`` for every vector in group ``i``.  All
-      entries must be positive and ``incy[i]`` must be at least
-      ``m[i]`` if column major layout is used or at
-      least ``n[i]`` if row major layout is used.
+      leading dimension of ``Y`` for every vector in group ``i``. Must
+      not be zero.
 
    group_count
       Specifies the number of groups. Must be at least 0.
@@ -450,13 +446,13 @@ total number of vectors in ``x`` and ``y`` and matrices in ``A`` are given by th
       ``n`` if row major layout is used.
 
    stridea
-      Stride between different ``A`` matrices.
+      Stride between different ``A`` matrices. Must be at least zero.
 
    x
       Pointer to the input vectors ``X`` with size ``stridex`` * ``batch_size``.
 
    incx
-      Stride of the vector ``X``. It must be positive.
+      Stride of the vector ``X``. Must not be zero.
 
    stridex
       Stride between different consecutive ``X`` vectors, must be at least 0.
@@ -468,12 +464,10 @@ total number of vectors in ``x`` and ``y`` and matrices in ``A`` are given by th
       Pointer to the input/output vectors ``Y`` with size ``stridey`` * ``batch_size``.
 
    incy
-      Stride between two consecutive elements of the ``y`` vectors.
+      Stride between two consecutive elements of the ``y`` vectors. Must not be zero.
 
    stridey
-      Stride between two consecutive ``Y`` vectors. Must be at least
-      (1 + (len-1)*abs(incy)) where ``len`` is ``m`` if the matrix ``A``
-      is non transpose or ``n`` otherwise.
+      Stride between two consecutive ``Y`` vectors. Must be at least (1 + (``m`` - 1)*abs(``incy``)) if layout is column major or (1 + (``n`` - 1)*abs(``incy``)) if row major layout is used.
 
    batch_size
       Specifies the number of matrix-vector operations to perform.

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

@@ -97,15 +97,15 @@ ger (Buffer Version)
       more details.
 
    incx
-      Stride of vector ``x``.
+      Stride of vector ``x``. Must not be zero.
 
    y
       Buffer holding input/output vector ``y``. The buffer must be of
       size at least (1 + (``n`` - 1)*abs(``incy``)). See :ref:`matrix-storage`
       for more details.
 
    incy
-      Stride of vector ``y``.
+      Stride of vector ``y``. Must not be zero.
 
    a
       Buffer holding input matrix ``A``. Must have size at least
@@ -207,7 +207,7 @@ ger (USM Version)
       more details.
 
    incx
-      Stride of vector ``x``.
+      Stride of vector ``x``. Must not be zero.
 
    y
       Pointer to input/output vector ``y``. The array holding
@@ -216,7 +216,7 @@ ger (USM Version)
       more details.
 
    incy
-      Stride of vector ``y``.
+      Stride of vector ``y``. Must not be zero.
 
    a
       Pointer to input matrix ``A``. Must have size at least

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

@@ -98,15 +98,15 @@ gerc (Buffer Version)
       more details.
 
    incx
-      Stride of vector ``x``.
+      Stride of vector ``x``. Must not be zero.
 
    y
       Buffer holding input/output vector ``y``. The buffer must be of
       size at least (1 + (``n`` - 1)*abs(``incy``)). See :ref:`matrix-storage`
       for more details.
 
    incy
-      Stride of vector ``y``.
+      Stride of vector ``y``. Must not be zero.
 
    a
       Buffer holding input matrix ``A``. Must have size at least
@@ -209,7 +209,7 @@ gerc (USM Version)
       more details.
 
    incx
-      Stride of vector ``x``.
+      Stride of vector ``x``. Must not be zero.
 
    y
       Pointer to the input/output vector ``y``. The array holding the
@@ -218,7 +218,7 @@ gerc (USM Version)
       more details.
 
    incy
-      Stride of vector ``y``.
+      Stride of vector ``y``. Must not be zero.
 
    a
       Pointer to input matrix ``A``. The array holding input matrix

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

@@ -97,15 +97,15 @@ geru (Buffer Version)
       more details.
 
    incx
-      Stride of vector ``x``.
+      Stride of vector ``x``. Must not be zero.
 
    y
       Buffer holding input/output vector ``y``. The buffer must be of
       size at least (1 + (``n`` - 1)*abs(``incy``)). See :ref:`matrix-storage`
       for more details.
 
    incy
-      Stride of vector ``y``.
+      Stride of vector ``y``. Must not be zero.
 
    a
       Buffer holding input matrix ``A``. Must have size at least
@@ -207,7 +207,7 @@ geru (USM Version)
       more details.
 
    incx
-      Stride of vector ``x``.
+      Stride of vector ``x``. Must not be zero.
 
    y
       Pointer to input/output vector ``y``. The array holding
@@ -216,7 +216,7 @@ geru (USM Version)
       more details.
 
    incy
-      Stride of vector ``y``.
+      Stride of vector ``y``. Must not be zero.
 
    a
       Pointer to input matrix ``A``. The array holding input matrix