Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop

Author: kgryte

lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

@@ -1444,12 +1444,12 @@ interface Namespace {
 	dsumpw: typeof dsumpw;
 
 	/**
-	* Adds a constant to each element in a strided array.
+	* Adds a scalar constant to each element in a strided array.
 	*
 	* @param N - number of indexed elements
-	* @param alpha - constant
+	* @param alpha - scalar constant
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns `x`
 	*
 	* @example
@@ -1467,12 +1467,12 @@ interface Namespace {
 	gapx: typeof gapx;
 
 	/**
-	* Adds a constant to each strided array element and computes the sum.
+	* Adds a scalar constant to each strided array element and computes the sum.
 	*
 	* @param N - number of indexed elements
 	* @param alpha - constant
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1513,12 +1513,12 @@ interface Namespace {
 	gapxsumkbn: typeof gapxsumkbn;
 
 	/**
-	* Adds a constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.
+	* Adds a scalar constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.
 	*
 	* @param N - number of indexed elements
-	* @param alpha - constant
+	* @param alpha - scalar constant
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1536,12 +1536,12 @@ interface Namespace {
 	gapxsumkbn2: typeof gapxsumkbn2;
 
 	/**
-	* Adds a constant to each strided array element and computes the sum using ordinary recursive summation.
+	* Adds a scalar constant to each strided array element and computes the sum using ordinary recursive summation.
 	*
 	* @param N - number of indexed elements
-	* @param alpha - constant
+	* @param alpha - scalar constant
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1559,12 +1559,12 @@ interface Namespace {
 	gapxsumors: typeof gapxsumors;
 
 	/**
-	* Adds a constant to each strided array element and computes the sum using pairwise summation.
+	* Adds a scalar constant to each strided array element and computes the sum using pairwise summation.
 	*
 	* @param N - number of indexed elements
-	* @param alpha - constant
+	* @param alpha - scalar constant
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1586,7 +1586,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1609,9 +1609,9 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param sum - initial sum
 	* @param x - input array
-	* @param strideX - `x` stride length
+	* @param strideX - stride length for `x`
 	* @param y - output array
-	* @param strideY - `y` stride length
+	* @param strideY - stride length for `y`
 	* @returns output array
 	*
 	* @example
@@ -1663,9 +1663,9 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param sum - initial sum
 	* @param x - input array
-	* @param strideX - `x` stride length
+	* @param strideX - stride length for `x`
 	* @param y - output array
-	* @param strideY - `y` stride length
+	* @param strideY - stride length for `y`
 	* @returns output array
 	*
 	* @example
@@ -1717,9 +1717,9 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param sum - initial sum
 	* @param x - input array
-	* @param strideX - `x` stride length
+	* @param strideX - stride length for `x`
 	* @param y - output array
-	* @param strideY - `y` stride length
+	* @param strideY - stride length for `y`
 	* @returns output array
 	*
 	* @example
@@ -1739,12 +1739,12 @@ interface Namespace {
 	gcusumpw: typeof gcusumpw;
 
 	/**
-	* Fills a strided array with a specified scalar value.
+	* Fills a strided array with a specified scalar constant.
 	*
 	* @param N - number of indexed elements
-	* @param alpha - constant
+	* @param alpha - scalar constant
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns `x`
 	*
 	* @example
@@ -1777,8 +1777,8 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
-	* @param clbk - callback
+	* @param strideX - stride length
+	* @param clbk - callback function
 	* @param thisArg - execution context
 	* @returns `x`
 	*
@@ -2169,7 +2169,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -2307,12 +2307,12 @@ interface Namespace {
 	sapxsum: typeof sapxsum;
 
 	/**
-	* Adds a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.
+	* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.
 	*
 	* @param N - number of indexed elements
-	* @param alpha - constant
+	* @param alpha - scalar constant
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -2446,9 +2446,9 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param sum - initial sum
 	* @param x - input array
-	* @param strideX - `x` stride length
+	* @param strideX - stride length for `x`
 	* @param y - output array
-	* @param strideY - `y` stride length
+	* @param strideY - stride length for `y`
 	* @returns output array
 	*
 	* @example

lib/node_modules/@stdlib/blas/ext/base/sapx/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # sapx
 
-> Add a constant to each element in a single-precision floating-point strided array.
+> Add a scalar constant to each element in a single-precision floating-point strided array.
 
 <section class="usage">
 
@@ -30,9 +30,9 @@ limitations under the License.
 var sapx = require( '@stdlib/blas/ext/base/sapx' );
 ```
 
-#### sapx( N, alpha, x, stride )
+#### sapx( N, alpha, x, strideX )
 
-Adds a constant `alpha` to each element in a single-precision floating-point strided array `x`.
+Adds a scalar constant to each element in a single-precision floating-point strided array.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -48,9 +48,9 @@ The function has the following parameters:
 -   **N**: number of indexed elements.
 -   **alpha**: scalar constant.
 -   **x**: input [`Float32Array`][@stdlib/array/float32].
--   **stride**: index increment.
+-   **strideX**: stride length.
 
-The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element
+The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element:
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -77,9 +77,9 @@ sapx( 3, 5.0, x1, 2 );
 // x0 => <Float32Array>[ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ]
 ```
 
-#### sapx.ndarray( N, alpha, x, stride, offset )
+#### sapx.ndarray( N, alpha, x, strideX, offsetX )
 
-Adds a constant `alpha` to each element in a single-precision floating-point strided array `x` using alternative indexing semantics.
+Adds a scalar constant to each element in a single-precision floating-point strided array using alternative indexing semantics.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -92,9 +92,9 @@ sapx.ndarray( x.length, 5.0, x, 1, 0 );
 
 The function has the following additional parameters:
 
--   **offset**: starting index.
+-   **offsetX**: starting index.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of the strided array
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of the strided array:
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -126,11 +126,12 @@ sapx.ndarray( 3, 5.0, x, 1, x.length-3 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var uniform = require( '@stdlib/random/base/uniform' ).factory;
-var filledarrayBy = require( '@stdlib/array/filled-by' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
 var sapx = require( '@stdlib/blas/ext/base/sapx' );
 
-var x = filledarrayBy( 10, 'float32', uniform( -100.0, 100.0 ) );
+var x = discreteUniform( 10, -100, 100, {
+    'dtype': 'float32'
+});
 console.log( x );
 
 sapx( x.length, 5.0, x, 1 );
@@ -141,6 +142,125 @@ console.log( x );
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/blas/ext/base/sapx.h"
+```
+
+#### stdlib_strided_sapx( N, alpha, \*X, strideX )
+
+Adds a scalar constant to each element in a single-precision floating-point strided array.
+
+```c
+float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+
+stdlib_strided_sapx( 4, 5.0f, x, 1 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **alpha**: `[in] float` scalar constant.
+-   **X**: `[inout] float*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length.
+
+```c
+void stdlib_strided_sapx( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_sapx_ndarray( N, alpha, \*X, strideX, offsetX )
+
+Adds a scalar constant to each element in a single-precision floating-point strided array using alternative indexing semantics.
+
+```c
+float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+
+stdlib_strided_sapx_ndarray( 4, 5.0f, x, 1, 0 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **alpha**: `[in] float` scalar constant.
+-   **X**: `[inout] float*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length.
+-   **offsetX**: `[in] CBLAS_INT` starting index.
+
+```c
+void stdlib_strided_sapx_ndarray( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/blas/ext/base/sapx.h"
+#include <stdio.h>
+
+int main( void ) {
+    // Create a strided array:
+    float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
+
+    // Specify the number of indexed elements:
+    const int N = 8;
+
+    // Specify a stride:
+    const int strideX = 1;
+
+    // Add a constant to each element:
+    stdlib_strided_sapx( N, 5.0f, x, strideX );
+
+    // Print the result:
+    for ( int i = 0; i < 8; i++ ) {
+        printf( "x[ %i ] = %f\n", i, x[ i ] );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">