chore: apply review changes

Author: aman-095

lib/node_modules/@stdlib/blas/base/ssymv/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # ssymv
 
-> Perform one of the matrix-vector operations `y = alpha*A*x + beta*y` where alpha and beta are scalars, x and y are n element vectors and A is an n by n symmetric matrix.
+> Perform one of the matrix-vector operations `y = α*A*x + β*y` where α and β are scalars, x and y are n element vectors and A is an n by n symmetric matrix.
 
 <section class = "usage">
 
@@ -30,41 +30,32 @@ limitations under the License.
 var ssymv = require( '@stdlib/blas/base/ssymv' );
 ```
 
-#### ssymv( ord, uplo, N, a, A, LDA, x, sx, b, y, sy )
+#### ssymv( ord, uplo, N, α, A, LDA, x, sx, β, y, sy )
 
-Performs one of the matrix-vector operations `y = alpha*A*x + beta*y` where alpha and beta are scalars, x and y are n element vectors and A is an n by n symmetric matrix.
+Performs one of the matrix-vector operations `y = α*A*x + β*y` where α and β are scalars, x and y are n element vectors and A is an n by n symmetric matrix.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
-var uplo = 'L';
-var order = 'row-major';
-
-var N = 3;
-var lda = 3;
-
-var alpha = 1.0;
-var beta = 0.0;
-
-var A = new Float32Array( [ 1.0, 0.0, 0.0, 2.0, 4.0, 0.0, 3.0, 5.0, 6.0 ] );
+var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
 var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
 
-ssymv( order, uplo, N, alpha, A, lda, x, 1, beta, y, 1 );
-// y => <Float32Array>[ 6.0, 11.0, 14.0 ]
+ssymv( 'row-major', 'lower', 3, 1.0, A, 3, x, 1, 0.0, y, 1 );
+// y => <Float32Array>[ 1.0, 2.0, 3.0 ]
 ```
 
 The function has the following parameters:
 
 -   **ord**: storage layout.
 -   **uplo**: specifies the operation to be performed.
 -   **N**: specifies the order of the matrix `A`.
--   **a**: scalar constant.
+-   **α**: scalar constant.
 -   **A**: matrix of coefficients [`Float32Array`][mdn-float32array].
 -   **lda**: stride of the first dimension of `A` (leading dimension of `A`).
 -   **x**: input [`Float32Array`][mdn-float32array].
 -   **sx**: index increment for `x`.
--   **b**: scalar constant.
+-   **β**: scalar constant.
 -   **y**: output [`Float32Array`][mdn-float32array].
 -   **sy**: index increment for `y`.
 
@@ -74,21 +65,12 @@ perform one of the matrix-vector operations starting from the second index of `x
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
-var uplo = 'U';
-var order = 'row-major';
-
-var N = 3;
-var lda = 3;
-
-var alpha = 2.0;
-var beta = 1.0;
-
-var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
 var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 var y = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 
-ssymv( order, uplo, N, alpha, A, lda, x, -1, beta, y, 1 );
-// y => <Float32Array>[ 21.0, 40.0, 53.0 ]
+ssymv( 'row-major', 'upper', 3, 2.0, A, 3, x, -1, 1.0, y, 1 );
+// y => <Float32Array>[ 7.0, 10.0, 9.0 ]
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -101,38 +83,29 @@ var Float32Array = require( '@stdlib/array/float32' );
 // Initial arrays...
 var x0 = new Float32Array( [ 1.0, 1.0, 1.0, 1.0 ] );
 var y0 = new Float32Array( [ 1.0, 1.0, 1.0, 1.0 ] );
-var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
 
 // Create offset views...
 var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
-var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 1st element
+var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-ssymv( 'row-major', 'U', 3, 1.0, A, 3, x1, -1, 1.0, y1, -1 );
-// y0 => <Float32Array>[ 1.0, 15.0, 12.0, 7.0 ]
+ssymv( 'row-major', 'upper', 3, 1.0, A, 3, x1, -1, 1.0, y1, -1 );
+// y0 => <Float32Array>[ 1.0, 4.0, 3.0, 2.0 ]
 ```
 
-#### ssymv.ndarray( ord, uplo, N, a, A, LDA, x, sx, ox, b, y, sy, oy )
+#### ssymv.ndarray( ord, uplo, N, α, A, LDA, x, sx, ox, β, y, sy, oy )
 
-Performs one of the matrix-vector operations `y = alpha*A*x + beta*y` where alpha and beta are scalars, x and y are n element vectors and A is an n by n symmetric matrix using alternative indexing semantics.
+Performs one of the matrix-vector operations `y = α*A*x + β*y` where α and β are scalars, x and y are n element vectors and A is an n by n symmetric matrix using alternative indexing semantics.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
-var uplo = 'U';
-var order = 'row-major';
-
-var N = 3;
-var lda = 3;
-
-var alpha = 2.0;
-var beta = 1.0;
-
-var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
 var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 var y = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 
-ssymv.ndarray( order, uplo, N, alpha, A, lda, x, -1, 2, beta, y, 1, 0 );
-// y => <Float32Array>[ 21.0, 40.0, 53.0 ]
+ssymv.ndarray( 'row-major', 'upper', 3, 2.0, A, 3, x, -1, 2, 1.0, y, 1, 0 );
+// y => <Float32Array>[ 7.0, 10.0, 9.0 ]
 ```
 
 The function has the following additional parameters:
@@ -145,21 +118,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
-var uplo = 'L';
-var order = 'row-major';
-
-var N = 3;
-var lda = 3;
-
-var alpha = 1.0;
-var beta = 0.0;
-
-var A = new Float32Array( [ 1.0, 0.0, 0.0, 2.0, 4.0, 0.0, 3.0, 5.0, 6.0 ] );
+var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
 var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
-var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
+var y = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 
-ssymv.ndarray( order, uplo, N, alpha, A, lda, x, 1, 0, beta, y, 1, 0 );
-// y => <Float32Array>[ 6.0, 11.0, 14.0 ]
+ssymv.ndarray( 'row-major', 'lower', 3, 1.0, A, 3, x, -1, 2, 1.0, y, -1, 2 );
+// y => <Float32Array>[ 4.0, 3.0, 2.0 ]
 ```
 
 </section>
@@ -184,26 +148,20 @@ ssymv.ndarray( order, uplo, N, alpha, A, lda, x, 1, 0, beta, y, 1, 0 );
 
 ```javascript
 var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var ones = require( '@stdlib/array/ones' );
 var ssymv = require( '@stdlib/blas/base/ssymv' );
 
 var opts = {
     'dtype': 'float32'
 };
 
-var uplo = 'U';
-
 var N = 3;
-var lda = 3;
-
-var alpha = 1;
-var beta = 1;
-
-var A = discreteUniform( N*N, 0, 255, opts );
+var A = ones( N*N, opts.dtype );
 
 var x = discreteUniform( N, 0, 255, opts );
 var y = discreteUniform( N, 0, 255, opts );
 
-ssymv.ndarray( 'row-major', uplo, N, alpha, A, lda, x, 1, 0, beta, y, 1, 0 );
+ssymv.ndarray( 'row-major', 'upper', N, 1.0, A, N, x, 1, 0, 1.0, y, 1, 0 );
 console.log( y );
 
 ```
@@ -235,7 +193,7 @@ console.log( y );
 ### Usage
 
 ```c
-#include "stdlib/blas/base/ssymv.h"
+TODO
 ```
 
 #### TODO

lib/node_modules/@stdlib/blas/base/ssymv/benchmark/benchmark.js

@@ -23,6 +23,7 @@
 var bench = require( '@stdlib/bench' );
 var uniform = require( '@stdlib/random/array/uniform' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var ones = require( '@stdlib/array/ones' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var floor = require( '@stdlib/math/base/special/floor' );
 var pkg = require( './../package.json' ).name;
@@ -48,7 +49,7 @@ var options = {
 function createBenchmark( N ) {
 	var x = uniform( N, -10.0, 10.0, options );
 	var y = uniform( N, -10.0, 10.0, options );
-	var A = uniform( N*N, -10.0, 10.0, options );
+	var A = ones( N*N, options.dtype );
 	return benchmark;
 
 	/**

lib/node_modules/@stdlib/blas/base/ssymv/benchmark/benchmark.ndarray.js

@@ -23,6 +23,7 @@
 var bench = require( '@stdlib/bench' );
 var uniform = require( '@stdlib/random/array/uniform' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var ones = require( '@stdlib/array/ones' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var floor = require( '@stdlib/math/base/special/floor' );
 var pkg = require( './../package.json' ).name;
@@ -48,7 +49,7 @@ var options = {
 function createBenchmark( N ) {
 	var x = uniform( N, -10.0, 10.0, options );
 	var y = uniform( N, -10.0, 10.0, options );
-	var A = uniform( N*N, -10.0, 10.0, options );
+	var A = ones( N*N, options.dtype );
 	return benchmark;
 
 	/**
@@ -98,7 +99,7 @@ function main() {
 	for ( i = min; i <= max; i++ ) {
 		N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
 		f = createBenchmark( N );
-		bench( pkg+':size='+(N*N), f );
+		bench( pkg+':ndarray:size='+(N*N), f );
 	}
 }
 

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

@@ -51,12 +51,12 @@ interface Routine {
 	* @example
 	* var Float32Array = require( '@stdlib/array/float32' );
 	*
-	* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
+	* var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
 	* var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 	* var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
 	*
 	* ssymv( 'row-major', 'lower', 3, 1.0, A, 3, x, 1, 0.0, y, 1 );
-	* // y => <Float32Array>[ 6.0, 11.0, 14.0 ]
+	* // y => <Float32Array>[ 1.0, 2.0, 3.0 ]
 	*/
 	( order: Order, uplo: UPLO, N: number, alpha: number, A: Float32Array, LDA: number, x: Float32Array, strideX: number, beta: number, y: Float32Array, strideY: number ): Float32Array;
 
@@ -81,12 +81,12 @@ interface Routine {
 	* @example
 	* var Float32Array = require( '@stdlib/array/float32' );
 	*
-	* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
+	* var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
 	* var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 	* var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
 	*
 	* ssymv.ndarray( 'row-major', 'lower', 3, 1.0, A, 3, x, 1, 0, 0.0, y, 1, 0 );
-	* // y => <Float32Array>[ 6.0, 11.0, 14.0 ]
+	* // y => <Float32Array>[ 1.0, 2.0, 3.0 ]
 	*/
 	ndarray( order: Order, uplo: UPLO, N: number, alpha: number, A: Float32Array, LDA: number, x: Float32Array, strideX: number, offsetX: number, beta: number, y: Float32Array, strideY: number, offsetY: number ): Float32Array;
 }
@@ -110,22 +110,22 @@ interface Routine {
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
 *
-* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
-* var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
-* var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
+* var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
+* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
+* var y = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 *
-* ssymv( 'row-major', 'lower', 3, 1.0, A, 3, x, 1, 0.0, y, 1 );
-* // y => <Float32Array>[ 6.0, 11.0, 14.0 ]
+* ssymv( 'row-major', 'upper', 3, 2.0, A, 3, x, 1, 1.0, y, 2 );
+* // y => <Float32Array>[ 3.0, 2.0, 11.0 ]
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
 *
-* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
-* var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
-* var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
+* var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
+* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
+* var y = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 *
-* ssymv.ndarray( 'row-major', 'lower', 3, 1.0, A, 3, x, 1, 0, 0.0, y, 1, 0 );
-* // y => <Float32Array>[ 6.0, 11.0, 14.0 ]
+* ssymv.ndarray( 'row-major', 'upper', 3, 2.0, A, 3, x, 1, 0, 1.0, y, 2, 0 );
+* // y => <Float32Array>[ 3.0, 2.0, 11.0 ]
 */
 declare var ssymv: Routine;
 

lib/node_modules/@stdlib/blas/base/ssymv/lib/index.js

@@ -27,23 +27,23 @@
 * var Float32Array = require( '@stdlib/array/float32' );
 * var ssymv = require( '@stdlib/blas/base/ssymv' );
 *
-* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
+* var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
 * var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 * var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
 *
 * ssymv( 'row-major', 'lower', 3, 1.0, A, 3, x, 1, 0.0, y, 1 );
-* // y => <Float32Array>[ 6.0, 11.0, 14.0 ]
+* // y => <Float32Array>[ 1.0, 2.0, 3.0 ]
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
 * var ssymv = require( '@stdlib/blas/base/ssymv' );
 *
-* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
+* var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
 * var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 * var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
 *
 * ssymv.ndarray( 'row-major', 'lower', 3, 1.0, A, 3, x, 1, 0, 0.0, y, 1, 0 );
-* // y => <Float32Array>[ 6.0, 11.0, 14.0 ]
+* // y => <Float32Array>[ 1.0, 2.0, 3.0 ]
 */
 
 // MODULES //