diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/README.md b/lib/node_modules/@stdlib/blas/base/ssyr/README.md index 46f70bb33083..d2c67b73039b 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/README.md +++ b/lib/node_modules/@stdlib/blas/base/ssyr/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2025 The Stdlib Authors. +Copyright (c) 2024 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -20,7 +20,7 @@ limitations under the License. # ssyr -> Perform the symmetric rank 1 operation `A = α*x*x**T + A`. +> Perform the symmetric rank 1 operation `A = α*x*x^T + A`.
@@ -32,16 +32,16 @@ var ssyr = require( '@stdlib/blas/base/ssyr' ); #### ssyr( order, uplo, N, α, x, sx, A, LDA ) -Performs the symmetric rank 1 operation `A = α*x*x**T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. +Performs the symmetric rank 1 operation `A = α*x*x^T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); +var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); ssyr( 'row-major', 'upper', 3, 1.0, x, 1, A, 3 ); -// A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] +// A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] ``` The function has the following parameters: @@ -51,20 +51,20 @@ The function has the following parameters: - **N**: number of elements along each dimension of `A`. - **α**: scalar constant. - **x**: input [`Float32Array`][mdn-float32array]. -- **sx**: index increment for `x`. +- **sx**: stride length for `x`. - **A**: input matrix stored in linear memory as a [`Float32Array`][mdn-float32array]. -- **lda**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`). +- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`). -The stride parameters determine how elements in the input arrays are accessed at runtime. For example, to iterate over every other element of `x` in reverse order, +The stride parameters determine how elements in the input arrays are accessed at runtime. For example, to iterate over the elements of `x` in reverse order, ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); -var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); +var x = new Float32Array( [ 3.0, 2.0, 1.0 ] ); -ssyr( 'row-major', 'upper', 3, 1.0, x, -2, A, 3 ); -// A => [ 26.0, 17.0, 8.0, 0.0, 10.0, 5.0, 0.0, 0.0, 2.0 ] +ssyr( 'row-major', 'upper', 3, 1.0, x, -1, A, 3 ); +// A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. @@ -75,14 +75,14 @@ Note that indexing is relative to the first index. To introduce an offset, use [ var Float32Array = require( '@stdlib/array/float32' ); // Initial arrays... -var x0 = new Float32Array( [ 1.0, 1.0, 1.0, 1.0 ] ); -var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); +var x0 = new Float32Array( [ 0.0, 3.0, 2.0, 1.0 ] ); +var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); // Create offset views... var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element ssyr( 'row-major', 'upper', 3, 1.0, x1, -1, A, 3 ); -// A => [ 2.0, 3.0, 4.0, 0.0, 2.0, 3.0, 0.0, 0.0, 2.0 ] +// A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] ``` #### ssyr.ndarray( uplo, N, α, x, sx, ox, A, sa1, sa2, oa ) @@ -92,11 +92,11 @@ Performs the symmetric rank 1 operation `A = α*x*x^T + A`, using alternative in ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); +var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); ssyr.ndarray( 'upper', 3, 1.0, x, 1, 0, A, 3, 1, 0 ); -// A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] +// A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] ``` The function has the following additional parameters: @@ -111,11 +111,11 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); +var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); ssyr.ndarray( 'upper', 3, 1.0, x, -2, 4, A, 3, 1, 0 ); -// A => [ 26.0, 17.0, 8.0, 0.0, 10.0, 5.0, 0.0, 0.0, 2.0 ] +// A => [ 26.0, 17.0, 8.0, 2.0, 10.0, 5.0, 3.0, 2.0, 2.0 ] ```
@@ -149,11 +149,18 @@ var opts = { var N = 3; -var A = ones( N*N, opts.dtype ); +// Create N-by-N symmetric matrices: +var A1 = ones( N*N, opts.dtype ); +var A2 = ones( N*N, opts.dtype ); + +// Create a random vector: var x = discreteUniform( N, -10.0, 10.0, opts ); -ssyr( 'row-major', 'upper', 3, 1.0, x, 1, A, 3 ); -console.log( A ); +ssyr( 'row-major', 'upper', 3, 1.0, x, 1, A1, 3 ); +console.log( A1 ); + +ssyr.ndarray( 'upper', 3, 1.0, x, 1, 0, A2, 3, 1, 0 ); +console.log( A2 ); ``` @@ -186,62 +193,62 @@ console.log( A ); #include "stdlib/blas/base/ssyr.h" ``` -#### c_ssyr( order, uplo, N, alpha, \*X, strideX, \*A, LDA ) +#### c_ssyr( layout, uplo, N, alpha, \*X, sx, \*A, LDA ) -Performs the symmetric rank 1 operation `A = α*x*x^T + A`. +Performs the symmetric rank 1 operation `A = α*x*x^T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. ```c #include "stdlib/blas/base/shared.h" -float A[] = { 1.0f, 0.0f, 0.0f, 2.0f, 1.0f, 0.0f, 3.0f, 2.0f, 1.0f }; -const float x[] = { 1.0f, 2.0f, 3.0f }; +float A[] = { 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 }; +const float x[] = { 1.0, 2.0, 3.0 }; -c_ssyr( CblasColMajor, CblasUpper, 3, 1.0f, x, 1, A, 3 ); +c_ssyr( CblasColMajor, CblasUpper, 3, 1.0, x, 1, A, 3 ); ``` The function accepts the following arguments: -- **order**: `[in] CBLAS_LAYOUT` storage layout. +- **layout**: `[in] CBLAS_LAYOUT` storage layout. - **uplo**: `[in] CBLAS_UPLO` specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced. - **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`. -- **alpha**: `[in] float` scalar. +- **alpha**: `[in] float` scalar constant. - **X**: `[in] float*` input array. -- **strideX**: `[in] CBLAS_INT` index increment for `X`. +- **sx**: `[in] CBLAS_INT` stride length for `X`. - **A**: `[inout] float*` input matrix. - **LDA**: `[in] CBLAS_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`). ```c -void c_ssyr( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ) +void c_ssyr( const CBLAS_LAYOUT layout, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ) ``` -#### c_ssyr_ndarray( uplo, N, alpha, \*X, strideX, offsetX, \*A, sa1, sa2, oa ) +#### c_ssyr_ndarray( uplo, N, alpha, \*X, sx, ox, \*A, sa1, sa2, oa ) -Performs the symmetric rank 1 operation `A = α*x*x^T + A` using alternative indexing semantics. +Performs the symmetric rank 1 operation `A = α*x*x^T + A`, using alternative indexing semantics and where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. ```c #include "stdlib/blas/base/shared.h" -float A[] = { 1.0f, 2.0f, 3.0f, 0.0f, 1.0f, 2.0f, 0.0f, 0.0f, 1.0f }; -const float x[] = { 1.0f, 2.0f, 3.0f }; +float A[] = { 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 }; +const float x[] = { 1.0, 2.0, 3.0 }; -c_ssyr_ndarray( CblasUpper, 3, 1.0f, x, 1, 0, A, 3, 1, 0 ); +c_ssyr_ndarray( CblasUpper, 3, 1.0, x, 1, 0, A, 3, 1, 0 ); ``` The function accepts the following arguments: - **uplo**: `[in] CBLAS_UPLO` specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced. - **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`. -- **alpha**: `[in] float` scalar. +- **alpha**: `[in] float` scalar constant. - **X**: `[in] float*` input array. -- **strideX**: `[in] CBLAS_INT` index increment for `X`. -- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **sx**: `[in] CBLAS_INT` stride length for `X`. +- **ox**: `[in] CBLAS_INT` starting index for `X`. - **A**: `[inout] float*` input matrix. - **sa1**: `[in] CBLAS_INT` stride of the first dimension of `A`. - **sa2**: `[in] CBLAS_INT` stride of the second dimension of `A`. - **oa**: `[in] CBLAS_INT` starting index for `A`. ```c -void c_ssyr_ndarray( const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *A, const CBLAS_INT sa1, const CBLAS_INT sa2, const CBLAS_INT oa ) +void c_ssyr_ndarray( const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *A, const CBLAS_INT strideA1, const CBLAS_INT strideA2, const CBLAS_INT offsetA ) ``` @@ -268,27 +275,39 @@ void c_ssyr_ndarray( const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha #include int main( void ) { - // Create strided arrays: - float A[] = { 1.0f, 0.0f, 0.0f, 2.0f, 1.0f, 0.0f, 3.0f, 2.0f, 1.0f }; - const float x[] = { 1.0f, 2.0f, 3.0f }; - - // Specify the number of elements along each dimension of `A`: + // Define 3x3 symmetric matrices stored in row-major layout: + float A1[ 3*3 ] = { + 1.0f, 2.0f, 3.0f, + 2.0f, 1.0f, 2.0f, + 3.0f, 2.0f, 1.0f + }; + + float A2[ 3*3 ] = { + 1.0f, 2.0f, 3.0f, + 2.0f, 1.0f, 2.0f, + 3.0f, 2.0f, 1.0f + }; + + // Define a vector: + const float x[ 3 ] = { 1.0f, 2.0f, 3.0f }; + + // Specify the number of elements along each dimension of `A1` and `A2`: const int N = 3; // Perform the symmetric rank 1 operation `A = α*x*x^T + A`: - c_ssyr( CblasColMajor, CblasUpper, N, 1.0f, x, 1, A, N ); + c_ssyr( CblasColMajor, CblasUpper, N, 1.0f, x, 1, A1, N ); // Print the result: for ( int i = 0; i < N*N; i++ ) { - printf( "A[ %i ] = %f\n", i, A[ i ] ); + printf( "A1[ %i ] = %f\n", i, A1[ i ] ); } - // Perform the symmetric rank 1 operation `A = α*x*x^T + A`: - c_ssyr_ndarray( CblasUpper, N, 1.0f, x, 1, 0, A, N, 1, 0 ); + // Perform the symmetric rank 1 operation `A = α*x*x^T + A` using alternative indexing semantics: + c_ssyr_ndarray( CblasUpper, N, 1.0, x, 1, 0, A2, N, 1, 0 ); // Print the result: for ( int i = 0; i < N*N; i++ ) { - printf( "A[ %i ] = %f\n", i, A[ i ] ); + printf( "A2[ %i ] = %f\n", i, A[ i ] ); } } ``` @@ -315,7 +334,7 @@ int main( void ) { [blas]: http://www.netlib.org/blas -[blas-ssyr]: https://www.netlib.org/lapack/explore-html/dc/d82/group__her_gad7585662770cdd3001ed08c7a864cd21.html#gad7585662770cdd3001ed08c7a864cd21 +[blas-ssyr]: https://www.netlib.org/lapack/explore-html-3.6.1/d6/d30/group__single__blas__level2_ga7b8a99048765ed2bf7c1e770bff0b622.html [mdn-float32array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/blas/base/ssyr/benchmark/c/benchmark.c index b011206956dd..08a08b53a12f 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/blas/base/ssyr/benchmark/c/benchmark.c @@ -83,7 +83,7 @@ static double tic( void ) { * Runs a benchmark. * * @param iterations number of iterations -* @param N number of elements along each dimension +* @param N array dimension size * @return elapsed time in seconds */ static double benchmark1( int iterations, int N ) { @@ -93,18 +93,18 @@ static double benchmark1( int iterations, int N ) { double t; int i; - stdlib_strided_sfill( N, 0.5f, x, 1 ); + stdlib_strided_sfill( N, 1.0f, x, 1 ); stdlib_strided_sfill( N*N, 1.0f, A, 1 ); t = tic(); for ( i = 0; i < iterations; i++ ) { - c_ssyr( CblasRowMajor, CblasUpper, N, 1.0, x, 1, A, N ); - if ( A[ 0 ] != A[ 0 ] ) { + c_ssyr( CblasRowMajor, CblasUpper, N, 1.0f, x, 1, A, N ); + if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) { printf( "should not return NaN\n" ); break; } } elapsed = tic() - t; - if ( A[ 0 ] != A[ 0 ] ) { + if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) { printf( "should not return NaN\n" ); } return elapsed; @@ -114,7 +114,7 @@ static double benchmark1( int iterations, int N ) { * Runs a benchmark. * * @param iterations number of iterations -* @param N number of elements along each dimension +* @param N array dimension size * @return elapsed time in seconds */ static double benchmark2( int iterations, int N ) { @@ -124,18 +124,18 @@ static double benchmark2( int iterations, int N ) { double t; int i; - stdlib_strided_sfill( N, 0.5f, x, 1 ); + stdlib_strided_sfill( N, 1.0f, x, 1 ); stdlib_strided_sfill( N*N, 1.0f, A, 1 ); t = tic(); for ( i = 0; i < iterations; i++ ) { - c_ssyr_ndarray( CblasUpper, N, 1.0, x, 1, 0, A, N, 1, 0 ); - if ( A[ 0 ] != A[ 0 ] ) { + c_ssyr_ndarray( CblasUpper, N, 1.0f, x, 1, 0, A, N, 1, 0 ); + if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) { printf( "should not return NaN\n" ); break; } } elapsed = tic() - t; - if ( A[ 0 ] != A[ 0 ] ) { + if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) { printf( "should not return NaN\n" ); } return elapsed; diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ssyr/docs/repl.txt index 2e2dd549e30b..20e6c104383f 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ssyr/docs/repl.txt @@ -46,10 +46,24 @@ Examples -------- + // Standard usage: > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, 1.0 ] ); - > var A = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 0.0, 2.0 ] ); + > var A = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 2.0, 1.0 ] ); > {{alias}}( 'row-major', 'upper', 2, 1.0, x, 1, A, 2 ) - [ 2.0, 3.0, 0.0, 3.0 ] + [ 2.0, 3.0, 2.0, 2.0 ] + + // Advanced indexing: + > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, 1.0 ] ); + > var A = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 2.0, 1.0 ] ); + > {{alias}}( 'row-major', 'upper', 2, 1.0, x, -1, A, 2 ) + [ 2.0, 3.0, 2.0, 2.0 ] + + // Using typed array views: + > var x0 = new {{alias:@stdlib/array/float32}}( [ 0.0, 1.0, 1.0 ] ); + > A = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 2.0, 1.0 ] ); + > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > {{alias}}( 'row-major', 'upper', 2, 1.0, x, 1, A, 2 ) + [ 2.0, 3.0, 2.0, 2.0 ] {{alias}}.ndarray( uplo, N, α, x, sx, ox, A, sa1, sa2, oa ) @@ -102,9 +116,9 @@ Examples -------- > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, 1.0 ] ); - > var A = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 0.0, 2.0 ] ); + > var A = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 2.0, 1.0 ] ); > {{alias}}.ndarray( 'upper', 2, 1.0, x, 1, 0, A, 2, 1, 0 ) - [ 2.0, 3.0, 0.0, 3.0 ] + [ 2.0, 3.0, 2.0, 2.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ssyr/docs/types/index.d.ts index ecd8c9b1e93c..6606508d807f 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ssyr/docs/types/index.d.ts @@ -42,16 +42,16 @@ interface Routine { * @example * var Float32Array = require( '@stdlib/array/float32' ); * - * var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] + * var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 2.0, 1.0, 2.0 ], [ 3.0, 2.0, 1.0 ] ] * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * * ssyr( 'row-major', 'upper', 3, 1.0, x, 1, A, 3 ); - * // A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] + * // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] */ ( order: Layout, uplo: MatrixTriangle, N: number, alpha: number, x: Float32Array, strideX: number, A: Float32Array, LDA: number ): Float32Array; /** - * Performs the symmetric rank 1 operation `A = α*x*x^T + A`, using alternative indexing semantics and where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. + * Performs the symmetric rank 1 operation `A = α*x*x^T + A` using alternative indexing semantics and where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. * * @param uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced * @param N - number of elements along each dimension in the matrix `A` @@ -68,11 +68,11 @@ interface Routine { * @example * var Float32Array = require( '@stdlib/array/float32' ); * - * var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] + * var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 2.0, 1.0, 2.0 ], [ 3.0, 2.0, 1.0 ] ] * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * * ssyr.ndarray( 'upper', 3, 1.0, x, 1, 0, A, 3, 1, 0 ); - * // A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] + * // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] */ ndarray( uplo: MatrixTriangle, N: number, alpha: number, x: Float32Array, strideX: number, offsetX: number, A: Float32Array, strideA1: number, strideA2: number, offsetA: number ): Float32Array; } @@ -93,20 +93,20 @@ interface Routine { * @example * var Float32Array = require( '@stdlib/array/float32' ); * -* var A = new Float32Array( [ 1.0, 1.0, 1.0, 0.0, 2.0, 2.0, 0.0, 0.0, 3.0 ] ); +* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * -* ssyr( 'column-major', 'lower', 3, 2.0, x, 1, A, 3 ); -* // y => [ 3.0, 5.0, 7.0, 0.0, 10.0, 14.0, 0.0, 0.0, 21.0 ] +* ssyr( 'row-major', 'upper', 3, 1.0, x, 1, A, 3 ); +* // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] * * @example * var Float32Array = require( '@stdlib/array/float32' ); * -* var A = new Float32Array( [ 1.0, 1.0, 1.0, 0.0, 2.0, 2.0, 0.0, 0.0, 3.0 ] ); +* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * -* ssyr.ndarray( 'lower', 3, 2.0, x, 1, 0, A, 3, 1, 0 ); -* // y => [ 3.0, 5.0, 7.0, 0.0, 10.0, 14.0, 0.0, 0.0, 21.0 ] +* ssyr.ndarray( 'upper', 3, 1.0, x, 1, 0, A, 3, 1, 0 ); +* // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] */ declare var ssyr: Routine; diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/examples/c/example.c b/lib/node_modules/@stdlib/blas/base/ssyr/examples/c/example.c index 79fd505af706..74b8e35f5b88 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/base/ssyr/examples/c/example.c @@ -21,26 +21,38 @@ #include int main( void ) { - // Create strided arrays: - float A[] = { 1.0f, 0.0f, 0.0f, 2.0f, 1.0f, 0.0f, 3.0f, 2.0f, 1.0f }; - const float x[] = { 1.0f, 2.0f, 3.0f }; + // Define 3x3 symmetric matrices stored in row-major layout: + float A1[ 3*3 ] = { + 1.0f, 2.0f, 3.0f, + 2.0f, 1.0f, 2.0f, + 3.0f, 2.0f, 1.0f + }; - // Specify the number of elements along each dimension of `A`: + float A2[ 3*3 ] = { + 1.0f, 2.0f, 3.0f, + 2.0f, 1.0f, 2.0f, + 3.0f, 2.0f, 1.0f + }; + + // Define a vector: + const float x[ 3 ] = { 1.0f, 2.0f, 3.0f }; + + // Specify the number of elements along each dimension of `A1` and `A2`: const int N = 3; // Perform the symmetric rank 1 operation `A = α*x*x^T + A`: - c_ssyr( CblasColMajor, CblasUpper, N, 1.0f, x, 1, A, N ); + c_ssyr( CblasColMajor, CblasUpper, N, 1.0f, x, 1, A1, N ); // Print the result: for ( int i = 0; i < N*N; i++ ) { - printf( "A[ %i ] = %f\n", i, A[ i ] ); + printf( "A1[ %i ] = %f\n", i, A1[ i ] ); } - // Perform the symmetric rank 1 operation `A = α*x*x^T + A`: - c_ssyr_ndarray( CblasUpper, N, 1.0f, x, 1, 0, A, N, 1, 0 ); + // Perform the symmetric rank 1 operation `A = α*x*x^T + A` using alternative indexing semantics: + c_ssyr_ndarray( CblasUpper, N, 1.0f, x, 1, 0, A2, N, 1, 0 ); // Print the result: for ( int i = 0; i < N*N; i++ ) { - printf( "A[ %i ] = %f\n", i, A[ i ] ); + printf( "A2[ %i ] = %f\n", i, A2[ i ] ); } } diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/examples/index.js b/lib/node_modules/@stdlib/blas/base/ssyr/examples/index.js index adca419f4049..68923b310abc 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/ssyr/examples/index.js @@ -28,8 +28,15 @@ var opts = { var N = 3; -var A = ones( N*N, opts.dtype ); +// Create N-by-N symmetric matrices: +var A1 = ones( N*N, opts.dtype ); +var A2 = ones( N*N, opts.dtype ); + +// Create a random vector: var x = discreteUniform( N, -10.0, 10.0, opts ); -ssyr( 'row-major', 'upper', 3, 1.0, x, 1, A, 3 ); -console.log( A ); +ssyr( 'row-major', 'upper', 3, 1.0, x, 1, A1, 3 ); +console.log( A1 ); + +ssyr.ndarray( 'upper', 3, 1.0, x, 1, 0, A2, 3, 1, 0 ); +console.log( A2 ); diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/include/stdlib/blas/base/ssyr.h b/lib/node_modules/@stdlib/blas/base/ssyr/include/stdlib/blas/base/ssyr.h index 5bfd9ba29ddc..81aa3ad0237a 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/include/stdlib/blas/base/ssyr.h +++ b/lib/node_modules/@stdlib/blas/base/ssyr/include/stdlib/blas/base/ssyr.h @@ -32,12 +32,12 @@ extern "C" { #endif /** -* Performs the symmetric rank 1 operation `A = α*x*x^T + A`. +* Performs the symmetric rank 1 operation `A = α*x*x^T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. */ -void API_SUFFIX(c_ssyr)( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ); +void API_SUFFIX(c_ssyr)( const CBLAS_LAYOUT layout, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ); /** -* Performs the symmetric rank 1 operation `A = α*x*x^T + A` using alternative indexing semantics. +* Performs the symmetric rank 1 operation `A = α*x*x^T + A`, using alternative indexing semantics and where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. */ void API_SUFFIX(c_ssyr_ndarray)( const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *A, const CBLAS_INT strideA1, const CBLAS_INT strideA2, const CBLAS_INT offsetA ); diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/include/stdlib/blas/base/ssyr_cblas.h b/lib/node_modules/@stdlib/blas/base/ssyr/include/stdlib/blas/base/ssyr_cblas.h index 7a4cc560e204..cf984264e617 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/include/stdlib/blas/base/ssyr_cblas.h +++ b/lib/node_modules/@stdlib/blas/base/ssyr/include/stdlib/blas/base/ssyr_cblas.h @@ -32,9 +32,9 @@ extern "C" { #endif /** -* Performs the symmetric rank 1 operation `A = α*x*x^T + A`. +* Performs the symmetric rank 1 operation `A = α*x*x^T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. */ -void API_SUFFIX(cblas_ssyr)( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ); +void API_SUFFIX(cblas_ssyr)( const CBLAS_LAYOUT layout, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/lib/base.js b/lib/node_modules/@stdlib/blas/base/ssyr/lib/base.js index f485e02b04a2..b495c70b0014 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/lib/base.js +++ b/lib/node_modules/@stdlib/blas/base/ssyr/lib/base.js @@ -21,7 +21,6 @@ // MODULES // var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major' ); -var f32 = require( '@stdlib/number/float64/base/to-float32' ); // MAIN // @@ -32,7 +31,7 @@ var f32 = require( '@stdlib/number/float64/base/to-float32' ); * @private * @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced * @param {NonNegativeInteger} N - number of elements along each dimension of `A` -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float32Array} x - input vector * @param {integer} strideX - `x` stride length * @param {NonNegativeInteger} offsetX - starting index for `x` @@ -45,11 +44,11 @@ var f32 = require( '@stdlib/number/float64/base/to-float32' ); * @example * var Float32Array = require( '@stdlib/array/float32' ); * -* var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] +* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 2.0, 1.0, 2.0 ], [ 3.0, 2.0, 1.0 ] ] * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * * ssyr( 'upper', 3, 1.0, x, 1, 0, A, 3, 1, 0 ); -* // A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] +* // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] */ function ssyr( uplo, N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offsetA ) { // eslint-disable-line max-len var isrm; @@ -60,7 +59,7 @@ function ssyr( uplo, N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offse var sa1; var i0; var i1; - var oa; + var ia; var ox; isrm = isRowMajor( [ strideA1, strideA2 ] ); @@ -75,18 +74,19 @@ function ssyr( uplo, N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offse } ox = offsetX; if ( - ( isrm && uplo === 'lower' ) || - ( !isrm && uplo === 'upper' ) + ( !isrm && uplo === 'upper' ) || + ( isrm && uplo === 'lower' ) ) { ix1 = ox; for ( i1 = 0; i1 < N; i1++ ) { if ( x[ ix1 ] !== 0.0 ) { - tmp = f32( alpha * x[ ix1 ] ); - oa = offsetA + (sa1*i1); + tmp = alpha * x[ ix1 ]; + ia = offsetA + (sa1*i1); ix0 = ox; for ( i0 = 0; i0 <= i1; i0++ ) { - A[ oa+(sa0*i0) ] += f32( x[ ix0 ] * tmp ); + A[ ia ] += x[ ix0 ] * tmp; ix0 += strideX; + ia += sa0; } } ix1 += strideX; @@ -97,12 +97,13 @@ function ssyr( uplo, N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offse ix1 = ox; for ( i1 = 0; i1 < N; i1++ ) { if ( x[ ix1 ] !== 0.0 ) { - tmp = f32( alpha * x[ ix1 ] ); - oa = offsetA + (sa1*i1); + tmp = alpha * x[ ix1 ]; + ia = offsetA + (sa1*i1) + (sa0*i1); ix0 = ix1; for ( i0 = i1; i0 < N; i0++ ) { - A[ oa+(sa0*i0) ] += f32( x[ ix0 ] * tmp ); + A[ ia ] += x[ ix0 ] * tmp; ix0 += strideX; + ia += sa0; } } ix1 += strideX; diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/lib/index.js b/lib/node_modules/@stdlib/blas/base/ssyr/lib/index.js index 96880f9d49a6..96a36f1c3cae 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/ssyr/lib/index.js @@ -37,11 +37,11 @@ * var Float32Array = require( '@stdlib/array/float32' ); * var ssyr = require( '@stdlib/blas/base/ssyr' ); * -* var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] +* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 2.0, 1.0, 2.0 ], [ 3.0, 2.0, 1.0 ] ] * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * * ssyr.ndarray( 'upper', 3, 1.0, x, 1, 0, A, 3, 1, 0 ); -* // A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] +* // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/ssyr/lib/ndarray.js index 5fd020560ee8..80b84bc65b05 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/ssyr/lib/ndarray.js @@ -32,7 +32,7 @@ var base = require( './base.js' ); * * @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced * @param {NonNegativeInteger} N - number of elements along each dimension of `A` -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float32Array} x - input vector * @param {integer} strideX - `x` stride length * @param {NonNegativeInteger} offsetX - starting index for `x` @@ -43,16 +43,18 @@ var base = require( './base.js' ); * @throws {TypeError} first argument must specify whether to reference the lower or upper triangular matrix * @throws {RangeError} second argument must be a nonnegative integer * @throws {RangeError} fifth argument must be non-zero +* @throws {RangeError} eighth argument must be non-zero +* @throws {RangeError} ninth argument must be non-zero * @returns {Float32Array} `A` * * @example * var Float32Array = require( '@stdlib/array/float32' ); * -* var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] +* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 2.0, 1.0, 2.0 ], [ 3.0, 2.0, 1.0 ] ] * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * * ssyr( 'upper', 3, 1.0, x, 1, 0, A, 3, 1, 0 ); -* // A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] +* // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] */ function ssyr( uplo, N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offsetA ) { // eslint-disable-line max-len if ( !isMatrixTriangle( uplo ) ) { @@ -70,6 +72,7 @@ function ssyr( uplo, N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offse if ( strideA2 === 0 ) { throw new RangeError( format( 'invalid argument. Ninth argument must be non-zero. Value: `%d`.', strideA2 ) ); } + // Check if we can early return... if ( N === 0 || alpha === 0.0 ) { return A; } diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/base/ssyr/lib/ndarray.native.js index 9c27a57d15d3..1ebf5befe2d2 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/base/ssyr/lib/ndarray.native.js @@ -20,7 +20,9 @@ // MODULES // +var isMatrixTriangle = require( '@stdlib/blas/base/assert/is-matrix-triangle' ); var resolveUplo = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +var format = require( '@stdlib/string/format' ); var addon = require( './../src/addon.node' ); @@ -31,7 +33,7 @@ var addon = require( './../src/addon.node' ); * * @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced * @param {NonNegativeInteger} N - number of elements along each dimension of `A` -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float32Array} x - input vector * @param {integer} strideX - `x` stride length * @param {NonNegativeInteger} offsetX - starting index for `x` @@ -39,18 +41,42 @@ var addon = require( './../src/addon.node' ); * @param {integer} strideA1 - stride of the first dimension of `A` * @param {integer} strideA2 - stride of the second dimension of `A` * @param {NonNegativeInteger} offsetA - starting index for `A` +* @throws {TypeError} first argument must specify whether to reference the lower or upper triangular matrix +* @throws {RangeError} second argument must be a nonnegative integer +* @throws {RangeError} fifth argument must be non-zero +* @throws {RangeError} eighth argument must be non-zero +* @throws {RangeError} ninth argument must be non-zero * @returns {Float32Array} `A` * * @example * var Float32Array = require( '@stdlib/array/float32' ); * -* var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] +* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 2.0, 1.0, 2.0 ], [ 3.0, 2.0, 1.0 ] ] * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * * ssyr( 'upper', 3, 1.0, x, 1, 0, A, 3, 1, 0 ); -* // A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] +* // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] */ function ssyr( uplo, N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offsetA ) { // eslint-disable-line max-len + if ( !isMatrixTriangle( uplo ) ) { + throw new TypeError( format( 'invalid argument. First argument must specify whether to reference the lower or upper triangular matrix. Value: `%s`.', uplo ) ); + } + if ( N < 0 ) { + throw new RangeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%d`.', N ) ); + } + if ( strideX === 0 ) { + throw new RangeError( format( 'invalid argument. Fifth argument must be non-zero. Value: `%d`.', strideX ) ); + } + if ( strideA1 === 0 ) { + throw new RangeError( format( 'invalid argument. Eighth argument must be non-zero. Value: `%d`.', strideA1 ) ); + } + if ( strideA2 === 0 ) { + throw new RangeError( format( 'invalid argument. Ninth argument must be non-zero. Value: `%d`.', strideA2 ) ); + } + // Check if we can early return... + if ( N === 0 || alpha === 0.0 ) { + return A; + } addon.ndarray( resolveUplo( uplo ), N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offsetA ); // eslint-disable-line max-len return A; } diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/lib/ssyr.js b/lib/node_modules/@stdlib/blas/base/ssyr/lib/ssyr.js index ec78aebbac2d..f10d3974de3d 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/lib/ssyr.js +++ b/lib/node_modules/@stdlib/blas/base/ssyr/lib/ssyr.js @@ -37,7 +37,7 @@ var base = require( './base.js' ); * @param {string} order - storage layout * @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced * @param {NonNegativeInteger} N - number of elements along each dimension of `A` -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float32Array} x - input vector * @param {integer} strideX - `x` stride length * @param {Float32Array} A - input matrix @@ -52,11 +52,11 @@ var base = require( './base.js' ); * @example * var Float32Array = require( '@stdlib/array/float32' ); * -* var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] +* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 2.0, 1.0, 2.0 ], [ 3.0, 2.0, 1.0 ] ] * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * * ssyr( 'row-major', 'upper', 3, 1.0, x, 1, A, 3 ); -* // A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] +* // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] */ function ssyr( order, uplo, N, alpha, x, strideX, A, LDA ) { var sa1; @@ -78,6 +78,7 @@ function ssyr( order, uplo, N, alpha, x, strideX, A, LDA ) { if ( LDA < max( 1, N ) ) { throw new RangeError( format( 'invalid argument. Eighth argument must be greater than or equal to max(1,%d). Value: `%d`.', N, LDA ) ); } + // Check if we can early return... if ( N === 0 || alpha === 0.0 ) { return A; } diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/lib/ssyr.native.js b/lib/node_modules/@stdlib/blas/base/ssyr/lib/ssyr.native.js index 48d68d82e4e2..79b0cd96aadb 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/lib/ssyr.native.js +++ b/lib/node_modules/@stdlib/blas/base/ssyr/lib/ssyr.native.js @@ -20,8 +20,12 @@ // MODULES // +var isLayout = require( '@stdlib/blas/base/assert/is-layout' ); +var isMatrixTriangle = require( '@stdlib/blas/base/assert/is-matrix-triangle' ); +var max = require( '@stdlib/math/base/special/fast/max' ); var resolveOrder = require( '@stdlib/blas/base/layout-resolve-enum' ); var resolveUplo = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +var format = require( '@stdlib/string/format' ); var addon = require( './../src/addon.node' ); @@ -33,23 +37,47 @@ var addon = require( './../src/addon.node' ); * @param {string} order - storage layout * @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced * @param {NonNegativeInteger} N - number of elements along each dimension of `A` -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float32Array} x - input vector * @param {integer} strideX - `x` stride length * @param {Float32Array} A - input matrix * @param {integer} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) +* @throws {TypeError} first argument must be a valid order +* @throws {TypeError} second argument must specify whether to reference the lower or upper triangular matrix +* @throws {RangeError} third argument must be a nonnegative integer +* @throws {RangeError} sixth argument must be non-zero +* @throws {RangeError} eighth argument must be greater than or equal to max(1,N) * @returns {Float32Array} `A` * * @example * var Float32Array = require( '@stdlib/array/float32' ); * -* var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] +* var A = new Float32Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 2.0, 1.0, 2.0 ], [ 3.0, 2.0, 1.0 ] ] * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); * * ssyr( 'row-major', 'upper', 3, 1.0, x, 1, A, 3 ); -* // A => [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] +* // A => [ 2.0, 4.0, 6.0, 2.0, 5.0, 8.0, 3.0, 2.0, 10.0 ] */ function ssyr( order, uplo, N, alpha, x, strideX, A, LDA ) { + if ( !isLayout( order ) ) { + throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) ); + } + if ( !isMatrixTriangle( uplo ) ) { + throw new TypeError( format( 'invalid argument. Second argument must specify whether to reference the lower or upper triangular matrix. Value: `%s`.', uplo ) ); + } + if ( N < 0 ) { + throw new RangeError( format( 'invalid argument. Third argument must be a nonnegative integer. Value: `%d`.', N ) ); + } + if ( strideX === 0 ) { + throw new RangeError( format( 'invalid argument. Sixth argument must be non-zero. Value: `%d`.', strideX ) ); + } + if ( LDA < max( 1, N ) ) { + throw new RangeError( format( 'invalid argument. Eighth argument must be greater than or equal to max(1,%d). Value: `%d`.', N, LDA ) ); + } + // Check if we can early return... + if ( N === 0 || alpha === 0.0 ) { + return A; + } addon( resolveOrder( order ), resolveUplo( uplo ), N, alpha, x, strideX, A, LDA ); // eslint-disable-line max-len return A; } diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/manifest.json b/lib/node_modules/@stdlib/blas/base/ssyr/manifest.json index 82ff44ce9dc7..637646eb1cec 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/manifest.json +++ b/lib/node_modules/@stdlib/blas/base/ssyr/manifest.json @@ -30,11 +30,84 @@ "confs": [ { "task": "build", - "os": "win", + "os": "linux", + "blas": "", + "wasm": false, + "src": [ + "./src/ssyr.c", + "./src/ssyr_ndarray.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-int32", + "@stdlib/napi/argv-float", + "@stdlib/napi/argv-strided-float32array", + "@stdlib/napi/argv-strided-float32array2d" + ] + }, + { + "task": "benchmark", + "os": "linux", + "blas": "", + "wasm": false, + "src": [ + "./src/ssyr.c", + "./src/ssyr_ndarray.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/blas/ext/base/sfill" + ] + }, + { + "task": "examples", + "os": "linux", + "blas": "", + "wasm": false, + "src": [ + "./src/ssyr.c", + "./src/ssyr_ndarray.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major" + ] + }, + + { + "task": "build", + "os": "linux", "blas": "openblas", "wasm": false, "src": [ - "./src/ssyr_cblas.c" + "./src/ssyr_cblas.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -46,22 +119,26 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", + "@stdlib/napi/argv-float", "@stdlib/napi/argv-strided-float32array", - "@stdlib/napi/argv-strided-float32array2d", - "@stdlib/napi/argv-float" + "@stdlib/napi/argv-strided-float32array2d" ] }, { "task": "benchmark", - "os": "win", + "os": "linux", "blas": "openblas", "wasm": false, "src": [ - "./src/ssyr_cblas.c" + "./src/ssyr_cblas.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -72,16 +149,21 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/blas/ext/base/sfill" ] }, { "task": "examples", - "os": "win", + "os": "linux", "blas": "openblas", "wasm": false, "src": [ - "./src/ssyr_cblas.c" + "./src/ssyr_cblas.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -92,7 +174,82 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major" + ] + }, + + { + "task": "build", + "os": "mac", + "blas": "", + "wasm": false, + "src": [ + "./src/ssyr.c", + "./src/ssyr_ndarray.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-int32", + "@stdlib/napi/argv-float", + "@stdlib/napi/argv-strided-float32array", + "@stdlib/napi/argv-strided-float32array2d" + ] + }, + { + "task": "benchmark", + "os": "mac", + "blas": "", + "wasm": false, + "src": [ + "./src/ssyr.c", + "./src/ssyr_ndarray.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/blas/ext/base/sfill" + ] + }, + { + "task": "examples", + "os": "mac", + "blas": "", + "wasm": false, + "src": [ + "./src/ssyr.c", + "./src/ssyr_ndarray.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major" ] }, @@ -102,7 +259,8 @@ "blas": "apple_accelerate_framework", "wasm": false, "src": [ - "./src/ssyr_cblas.c" + "./src/ssyr_cblas.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -113,13 +271,16 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", + "@stdlib/napi/argv-float", "@stdlib/napi/argv-strided-float32array", - "@stdlib/napi/argv-strided-float32array2d", - "@stdlib/napi/argv-float" + "@stdlib/napi/argv-strided-float32array2d" ] }, { @@ -128,7 +289,8 @@ "blas": "apple_accelerate_framework", "wasm": false, "src": [ - "./src/ssyr_cblas.c" + "./src/ssyr_cblas.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -138,7 +300,11 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/blas/ext/base/sfill" ] }, { @@ -147,7 +313,8 @@ "blas": "apple_accelerate_framework", "wasm": false, "src": [ - "./src/ssyr_cblas.c" + "./src/ssyr_cblas.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -157,7 +324,10 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major" ] }, @@ -167,7 +337,8 @@ "blas": "openblas", "wasm": false, "src": [ - "./src/ssyr_cblas.c" + "./src/ssyr_cblas.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -179,13 +350,16 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", + "@stdlib/napi/argv-float", "@stdlib/napi/argv-strided-float32array", - "@stdlib/napi/argv-strided-float32array2d", - "@stdlib/napi/argv-float" + "@stdlib/napi/argv-strided-float32array2d" ] }, { @@ -194,7 +368,8 @@ "blas": "openblas", "wasm": false, "src": [ - "./src/ssyr_cblas.c" + "./src/ssyr_cblas.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -205,7 +380,11 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/blas/ext/base/sfill" ] }, { @@ -214,7 +393,8 @@ "blas": "openblas", "wasm": false, "src": [ - "./src/ssyr_cblas.c" + "./src/ssyr_cblas.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -225,17 +405,21 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major" ] }, { "task": "build", - "os": "linux", + "os": "win", "blas": "", "wasm": false, "src": [ - "./src/ssyr.c" + "./src/ssyr.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -244,24 +428,26 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", + "@stdlib/strided/base/stride2offset", + "@stdlib/ndarray/base/assert/is-row-major", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", - "@stdlib/napi/argv-strided-float32array", - "@stdlib/napi/argv-strided-float32array2d", "@stdlib/napi/argv-float", - "@stdlib/strided/base/stride2offset", - "@stdlib/ndarray/base/assert/is-row-major" + "@stdlib/napi/argv-strided-float32array", + "@stdlib/napi/argv-strided-float32array2d" ] }, { "task": "benchmark", - "os": "linux", + "os": "win", "blas": "", "wasm": false, "src": [ - "./src/ssyr.c" + "./src/ssyr.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -270,19 +456,20 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", - "@stdlib/blas/ext/base/sfill", - "@stdlib/math/base/special/floorf", + "@stdlib/blas/base/xerbla", "@stdlib/strided/base/stride2offset", - "@stdlib/ndarray/base/assert/is-row-major" + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/blas/ext/base/sfill" ] }, { "task": "examples", - "os": "linux", + "os": "win", "blas": "", "wasm": false, "src": [ - "./src/ssyr.c" + "./src/ssyr.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -291,6 +478,7 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", "@stdlib/strided/base/stride2offset", "@stdlib/ndarray/base/assert/is-row-major" ] @@ -302,7 +490,8 @@ "blas": "", "wasm": true, "src": [ - "./src/ssyr.c" + "./src/ssyr.c", + "./src/ssyr_ndarray.c" ], "include": [ "./include" @@ -311,6 +500,7 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", + "@stdlib/blas/base/xerbla", "@stdlib/strided/base/stride2offset", "@stdlib/ndarray/base/assert/is-row-major" ] diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/src/addon.c b/lib/node_modules/@stdlib/blas/base/ssyr/src/addon.c index 558db6a0786e..d891de8b0a00 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/src/addon.c +++ b/lib/node_modules/@stdlib/blas/base/ssyr/src/addon.c @@ -35,9 +35,12 @@ * @return Node-API value */ static napi_value addon( napi_env env, napi_callback_info info ) { + CBLAS_INT sa1; + CBLAS_INT sa2; + STDLIB_NAPI_ARGV( env, info, argv, argc, 8 ); - STDLIB_NAPI_ARGV_INT32( env, order, argv, 0 ); + STDLIB_NAPI_ARGV_INT32( env, layout, argv, 0 ); STDLIB_NAPI_ARGV_INT32( env, uplo, argv, 1 ); STDLIB_NAPI_ARGV_INT64( env, N, argv, 2 ); @@ -46,10 +49,17 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_FLOAT( env, alpha, argv, 3 ); + if ( layout == CblasColMajor ) { + sa1 = 1; + sa2 = LDA; + } else { // layout == CblasRowMajor + sa1 = LDA; + sa2 = 1; + } STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 4 ); - STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, A, ((N-1)*LDA) + N, 1, argv, 6 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY2D( env, A, N, N, sa1, sa2, argv, 6 ); - API_SUFFIX(c_ssyr)( order, uplo, N, alpha, X, strideX, A, LDA ); + API_SUFFIX(c_ssyr)( layout, uplo, N, alpha, X, strideX, A, LDA ); return NULL; } diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr.c b/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr.c index 74929aabfcfc..9c5a043f47e7 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr.c +++ b/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr.c @@ -18,114 +18,66 @@ #include "stdlib/blas/base/ssyr.h" #include "stdlib/blas/base/shared.h" +#include "stdlib/blas/base/xerbla.h" #include "stdlib/strided/base/stride2offset.h" -#include "stdlib/ndarray/base/assert/is_row_major.h" /** -* Performs the symmetric rank 1 operation `A = α*x*x^T + A`. +* Performs the symmetric rank 1 operation `A = α*x*x^T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. * -* @param order storage layout +* @param layout storage layout * @param uplo specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced * @param N number of elements along each dimension of `A` -* @param alpha scalar +* @param alpha scalar constant * @param X input vector * @param strideX `X` stride length * @param A input matrix * @param LDA stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) */ -void API_SUFFIX(c_ssyr)( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ) { +void API_SUFFIX(c_ssyr)( const CBLAS_LAYOUT layout, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ) { + CBLAS_INT vala; CBLAS_INT sa1; CBLAS_INT sa2; CBLAS_INT ox; - if ( N == 0 || alpha == 0.0f ) { + // Perform input argument validation... + if ( layout != CblasRowMajor && layout != CblasColMajor ) { + c_xerbla( 1, "c_ssyr", "Error: invalid argument. First argument must be a valid layout. Value: `%d`.", layout ); return; } - if ( order == CblasColMajor ) { - sa1 = 1; - sa2 = LDA; - } else { // order == 'row-major' - sa1 = LDA; - sa2 = 1; + if ( uplo != CblasLower && uplo != CblasUpper ) { + c_xerbla( 2, "c_ssyr", "Error: invalid argument. Second argument must specify whether to reference the lower or upper triangular matrix. Value: `%d`.", uplo ); + return; } - ox = STDLIB_BLAS_BASE_STRIDE2OFFSET( N, strideX ); - API_SUFFIX(c_ssyr_ndarray)( uplo, N, alpha, X, strideX, ox, A, sa1, sa2, 0 ); - return; -} - -/** -* Performs the symmetric rank 1 operation `A = α*x*x^T + A` using alternative indexing semantics. -* -* @param uplo specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced -* @param N number of elements along each dimension of `A` -* @param alpha scalar -* @param X input vector -* @param strideX `X` stride length -* @param offsetX starting index of `X` -* @param A input matrix -* @param strideA1 stride of the first dimension of `A` -* @param strideA2 stride of the second dimension of `A` -* @param offsetA starting index of `A` -*/ -void API_SUFFIX(c_ssyr_ndarray)( const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *A, const CBLAS_INT strideA1, const CBLAS_INT strideA2, const CBLAS_INT offsetA ) { - CBLAS_INT isrm; - CBLAS_INT ix0; - CBLAS_INT ix1; - CBLAS_INT sa0; - CBLAS_INT sa1; - CBLAS_INT i0; - CBLAS_INT i1; - CBLAS_INT oa; - CBLAS_INT ox; - float tmp; - - int64_t strides[] = { strideA1, strideA2 }; - if ( N == 0 || alpha == 0.0f ) { + if ( N < 0 ) { + c_xerbla( 3, "c_ssyr", "Error: invalid argument. Third argument must be a nonnegative integer. Value: `%d`.", N ); return; } - isrm = stdlib_ndarray_is_row_major( 2, strides ); - if ( isrm ) { - // For row-major matrices, the last dimension has the fastest changing index... - sa0 = strideA2; // stride for innermost loop - sa1 = strideA1; // stride for outermost loop - } else { // isColMajor - // For column-major matrices, the first dimension has the fastest changing index... - sa0 = strideA1; // stride for innermost loop - sa1 = strideA2; // stride for outermost loop + if ( strideX == 0 ) { + c_xerbla( 6, "c_ssyr", "Error: invalid argument. Sixth argument must be nonzero. Value: `%d`.", strideX ); + return; } - ox = offsetX; - if ( - ( isrm && uplo == CblasLower ) || - ( !isrm && uplo == CblasUpper ) - ) { - ix1 = ox; - for ( i1 = 0; i1 < N; i1++ ) { - if ( X[ ix1 ] != 0.0f ) { - tmp = alpha * X[ ix1 ]; - oa = offsetA + (sa1*i1); - ix0 = ox; - for ( i0 = 0; i0 <= i1; i0++ ) { - A[ oa+(sa0*i0) ] += X[ ix0 ] * tmp; - ix0 += strideX; - } - } - ix1 += strideX; - } + // max(1, N) + if ( N < 1 ) { + vala = 1; + } else { + vala = N; + } + if ( LDA < vala ) { + c_xerbla( 10, "c_ssyr", "Error: invalid argument. Eighth argument must be greater than or equal to max(1,%d). Value: `%d`.", vala, LDA ); return; } - // ( isrm && uplo == 'CblasUpper' ) || ( !isrm && uplo == 'CblasLower' ) - ix1 = ox; - for ( i1 = 0; i1 < N; i1++ ) { - if ( X[ ix1 ] != 0.0f ) { - tmp = alpha * X[ ix1 ]; - oa = offsetA + (sa1*i1); - ix0 = ix1; - for ( i0 = i1; i0 < N; i0++ ) { - A[ oa+(sa0*i0) ] += X[ ix0 ] * tmp; - ix0 += strideX; - } - } - ix1 += strideX; + // Check whether we can avoid computation altogether... + if ( N == 0 || alpha == 0.0f ) { + return; } + if ( layout == CblasColMajor ) { + sa1 = 1; + sa2 = LDA; + } else { // layout == CblasRowMajor + sa1 = LDA; + sa2 = 1; + } + ox = stdlib_strided_stride2offset( N, strideX ); + API_SUFFIX(c_ssyr_ndarray)( uplo, N, alpha, X, strideX, ox, A, sa1, sa2, 0 ); return; } diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr_cblas.c b/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr_cblas.c index de11f791c556..ece591d7abcc 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr_cblas.c +++ b/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr_cblas.c @@ -21,17 +21,17 @@ #include "stdlib/blas/base/shared.h" /** -* Performs the symmetric rank 1 operation `A = α*x*x^T + A`. +* Performs the symmetric rank 1 operation `A = α*x*x^T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. * -* @param order storage layout +* @param layout storage layout * @param uplo specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced * @param N number of elements along each dimension of `A` -* @param alpha scalar -* @param x input vector +* @param alpha scalar constant +* @param X input vector * @param strideX `X` stride length * @param A input matrix * @param LDA stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) */ -void API_SUFFIX(c_ssyr)( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ) { - API_SUFFIX(cblas_ssyr)( order, uplo, N, alpha, X, strideX, A, LDA ); +void API_SUFFIX(c_ssyr)( const CBLAS_LAYOUT layout, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA ) { + API_SUFFIX(cblas_ssyr)( layout, uplo, N, alpha, X, strideX, A, LDA ); } diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr_ndarray.c b/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr_ndarray.c new file mode 100644 index 000000000000..730c2d69d120 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ssyr/src/ssyr_ndarray.c @@ -0,0 +1,120 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/blas/base/ssyr.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/blas/base/xerbla.h" +#include "stdlib/ndarray/base/assert/is_row_major.h" + +/** +* Performs the symmetric rank 1 operation `A = α*x*x^T + A`, using alternative indexing semantics and where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix. +* +* @param uplo specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced +* @param N number of elements along each dimension of `A` +* @param alpha scalar constant +* @param X input vector +* @param strideX `X` stride length +* @param offsetX starting index of `X` +* @param A input matrix +* @param strideA1 stride of the first dimension of `A` +* @param strideA2 stride of the second dimension of `A` +* @param offsetA starting index of `A` +*/ +void API_SUFFIX(c_ssyr_ndarray)( const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *A, const CBLAS_INT strideA1, const CBLAS_INT strideA2, const CBLAS_INT offsetA ) { + int64_t sa[ 2 ]; + CBLAS_INT isrm; + CBLAS_INT ix0; + CBLAS_INT ix1; + CBLAS_INT sa0; + CBLAS_INT sa1; + CBLAS_INT i0; + CBLAS_INT i1; + CBLAS_INT ia; + CBLAS_INT ox; + float tmp; + + // Note on variable naming convention: sa#, ix#, iy#, i# where # corresponds to the loop number, with `0` being the innermost loop... + + // Perform input argument validation... + if ( uplo != CblasLower && uplo != CblasUpper ) { + c_xerbla( 1, "c_ssyr_ndarray", "Error: invalid argument. First argument must specify whether to reference the lower or upper triangular matrix. Value: `%d`.", uplo ); + return; + } + if ( N < 0 ) { + c_xerbla( 2, "c_ssyr_ndarray", "Error: invalid argument. Second argument must be a nonnegative integer. Value: `%d`.", N ); + return; + } + if ( strideX == 0 ) { + c_xerbla( 5, "c_ssyr_ndarray", "Error: invalid argument. Fifth argument must be a nonzero. Value: `%d`.", strideX ); + return; + } + // Check whether we can avoid computation altogether... + if ( N == 0 || alpha == 0.0f ) { + return; + } + // Extract loop variables for purposes of loop interchange: dimensions and loop offset (pointer) increments... + sa[ 0 ] = strideA1; + sa[ 1 ] = strideA2; + isrm = stdlib_ndarray_is_row_major( 2, sa ); + if ( isrm ) { + // For row-major matrices, the last dimension has the fastest changing index... + sa0 = strideA2; // stride for innermost loop + sa1 = strideA1; // stride for outermost loop + } else { // isColMajor + // For column-major matrices, the first dimension has the fastest changing index... + sa0 = strideA1; // stride for innermost loop + sa1 = strideA2; // stride for outermost loop + } + ox = offsetX; + if ( + ( isrm && uplo == CblasLower ) || + ( !isrm && uplo == CblasUpper ) + ) { + ix1 = ox; + for ( i1 = 0; i1 < N; i1++ ) { + if ( X[ ix1 ] != 0.0f ) { + tmp = alpha * X[ ix1 ]; + ia = offsetA + (sa1*i1); + ix0 = ox; + for ( i0 = 0; i0 <= i1; i0++ ) { + A[ ia ] += X[ ix0 ] * tmp; + ix0 += strideX; + ia += sa0; + } + } + ix1 += strideX; + } + return; + } + // ( isrm && uplo == CblasUpper ) || ( !isrm && uplo == CblasLower ) + ix1 = ox; + for ( i1 = 0; i1 < N; i1++ ) { + if ( X[ ix1 ] != 0.0f ) { + tmp = alpha * X[ ix1 ]; + ia = offsetA + (sa1*i1) + (sa0*i1); + ix0 = ix1; + for ( i0 = i1; i0 < N; i0++ ) { + A[ ia ] += X[ ix0 ] * tmp; + ix0 += strideX; + ia += sa0; + } + } + ix1 += strideX; + } + return; +} diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/base/ssyr/test/test.ndarray.native.js index 30c45558c698..6343aca76b09 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/base/ssyr/test/test.ndarray.native.js @@ -25,7 +25,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); var Float32Array = require( '@stdlib/array/float32' ); -var str2enumMatrixTriangle = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -77,6 +76,126 @@ tape( 'the function has an arity of 10', opts, function test( t ) { t.end(); }); +tape( 'the function throws an error if provided an invalid first argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + 'foo', + 'bar', + 'beep', + 'boop' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( value, data.N, data.alpha, new Float32Array( data.x ), data.strideX, data.offsetX, new Float32Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid second argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( data.uplo, value, data.alpha, new Float32Array( data.x ), data.strideX, data.offsetX, new Float32Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid fifth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( data.uplo, data.N, data.alpha, new Float32Array( data.x ), value, data.offsetX, new Float32Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid eighth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( data.uplo, data.N, data.alpha, new Float32Array( data.x ), data.strideX, data.offsetX, new Float32Array( data.A ), value, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid ninth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( data.uplo, data.N, data.alpha, new Float32Array( data.x ), data.strideX, data.offsetX, new Float32Array( data.A ), data.strideA1, value, data.offsetA ); + }; + } +}); + tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (row-major, upper)', opts, function test( t ) { var expected; var data; @@ -91,7 +210,7 @@ tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -112,7 +231,7 @@ tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -133,7 +252,7 @@ tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -154,7 +273,7 @@ tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -172,7 +291,7 @@ tape( 'the function returns a reference to the input matrix `A`', opts, function a = new Float32Array( data.A ); x = new Float32Array( data.x ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.end(); @@ -192,11 +311,11 @@ tape( 'if `N` is zero or the scalar constant is zero, the function returns the i expected = new Float32Array( data.A ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), 0, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, 0, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( a, expected, 'returns expected value' ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, 0.0, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, 0.0, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( a, expected, 'returns expected value' ); @@ -217,11 +336,11 @@ tape( 'if `N` is zero or the scalar constant is zero, the function returns the i expected = new Float32Array( data.A ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), 0, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, 0, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( a, expected, 'returns expected value' ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, 0.0, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, 0.0, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( a, expected, 'returns expected value' ); @@ -242,7 +361,7 @@ tape( 'the function supports specifying the strides of the first and second dime expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -263,7 +382,7 @@ tape( 'the function supports specifying the strides of the first and second dime expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -284,7 +403,7 @@ tape( 'the function supports a negative stride for the first dimension of `A` (r expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -305,7 +424,7 @@ tape( 'the function supports a negative stride for the first dimension of `A` (c expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -326,7 +445,7 @@ tape( 'the function supports a negative stride for the second dimension of `A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -347,7 +466,7 @@ tape( 'the function supports a negative stride for the second dimension of `A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -368,7 +487,7 @@ tape( 'the function supports negative strides for both dimensions of `A` (row-ma expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -389,7 +508,7 @@ tape( 'the function supports negative strides for both dimensions of `A` (column expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -410,7 +529,7 @@ tape( 'the function supports specifying an `A` offset (row-major)', opts, functi expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -431,7 +550,7 @@ tape( 'the function supports specifying an `A` offset (column-major)', opts, fun expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -452,7 +571,7 @@ tape( 'the function supports specifying an `x` stride (row-major)', opts, functi expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -473,7 +592,7 @@ tape( 'the function supports specifying an `x` stride (column-major)', opts, fun expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -494,7 +613,7 @@ tape( 'the function supports specifying a negative `x` stride (row-major)', opts expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -515,7 +634,7 @@ tape( 'the function supports specifying a negative `x` stride (column-major)', o expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -578,7 +697,7 @@ tape( 'the function supports complex access patterns (row-major)', opts, functio expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -599,7 +718,7 @@ tape( 'the function supports complex access patterns (column-major)', opts, func expected = new Float32Array( data.A_out ); - out = ssyr( str2enumMatrixTriangle( data.uplo ), data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); + out = ssyr( data.uplo, data.N, data.alpha, x, data.strideX, data.offsetX, a, data.strideA1, data.strideA2, data.offsetA ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); diff --git a/lib/node_modules/@stdlib/blas/base/ssyr/test/test.ssyr.native.js b/lib/node_modules/@stdlib/blas/base/ssyr/test/test.ssyr.native.js index 96e34b00e9f5..3337635e8801 100644 --- a/lib/node_modules/@stdlib/blas/base/ssyr/test/test.ssyr.native.js +++ b/lib/node_modules/@stdlib/blas/base/ssyr/test/test.ssyr.native.js @@ -25,8 +25,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); var Float32Array = require( '@stdlib/array/float32' ); -var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); -var str2enumLayout = require( '@stdlib/blas/base/layout-str2enum' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -64,6 +62,134 @@ tape( 'the function has an arity of 8', opts, function test( t ) { t.end(); }); +tape( 'the function throws an error if provided an invalid first argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + 'foo', + 'bar', + 'beep', + 'boop' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( value, data.uplo, data.N, data.alpha, new Float32Array( data.x ), data.strideX, new Float32Array( data.A ), data.lda ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid second argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + 'foo', + 'bar', + 'beep', + 'boop' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( data.order, value, data.N, data.alpha, new Float32Array( data.x ), data.strideX, new Float32Array( data.A ), data.lda ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid third argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( data.order, data.uplo, value, data.alpha, new Float32Array( data.x ), data.strideX, new Float32Array( data.A ), data.lda ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid sixth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( data.order, data.uplo, data.N, data.alpha, new Float32Array( data.x ), value, new Float32Array( data.A ), data.lda ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid eighth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = ru; + + values = [ + 2, + 1, + 0, + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + ssyr( data.order, data.uplo, data.N, data.alpha, new Float32Array( data.x ), data.strideX, new Float32Array( data.A ), value ); + }; + } +}); + tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (row-major, upper)', opts, function test( t ) { var expected; var data; @@ -78,7 +204,7 @@ tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -99,7 +225,7 @@ tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -120,7 +246,7 @@ tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -141,7 +267,7 @@ tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` ( expected = new Float32Array( data.A_out ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -159,7 +285,7 @@ tape( 'the function returns a reference to the input matrix `A`', opts, function a = new Float32Array( data.A ); x = new Float32Array( data.x ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.end(); @@ -179,11 +305,11 @@ tape( 'if `N` is zero or the scalar constant is zero, the function returns the i expected = new Float32Array( data.A ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), 0, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, 0, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( a, expected, 'returns expected value' ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, 0.0, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, 0.0, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( a, expected, 'returns expected value' ); @@ -204,11 +330,11 @@ tape( 'if `N` is zero or the scalar constant is zero, the function returns the i expected = new Float32Array( data.A ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), 0, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, 0, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( a, expected, 'returns expected value' ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, 0.0, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, 0.0, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( a, expected, 'returns expected value' ); @@ -229,7 +355,7 @@ tape( 'the function supports specifying an `x` stride (row-major)', opts, functi expected = new Float32Array( data.A_out ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -250,7 +376,7 @@ tape( 'the function supports specifying an `x` stride (column-major)', opts, fun expected = new Float32Array( data.A_out ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -271,7 +397,7 @@ tape( 'the function supports specifying a negative `x` stride (row-major)', opts expected = new Float32Array( data.A_out ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' ); @@ -292,7 +418,7 @@ tape( 'the function supports specifying a negative `x` stride (column-major)', o expected = new Float32Array( data.A_out ); - out = ssyr( str2enumLayout( data.order ), str2enum( data.uplo ), data.N, data.alpha, x, data.strideX, a, data.lda ); + out = ssyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); t.strictEqual( out, a, 'returns expected value' ); t.deepEqual( out, expected, 'returns expected value' );