diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/README.md b/lib/node_modules/@stdlib/blas/base/dsyr/README.md new file mode 100644 index 00000000000..988613098c3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/README.md @@ -0,0 +1,255 @@ + + +# dsyr + +> Perform the symmetric rank 1 operation `A = α*x*x^T + A`. + +
+ +## Usage + +```javascript +var dsyr = require( '@stdlib/blas/base/dsyr' ); +``` + +#### dsyr( 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. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var A = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); +var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + +dsyr( '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 ] +``` + +The function has the following parameters: + +- **order**: storage layout. +- **uplo**: specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced. +- **N**: number of elements along each dimension of `A`. +- **α**: scalar constant. +- **x**: input [`Float64Array`][mdn-float64array]. +- **sx**: index increment for `x`. +- **A**: input matrix stored in linear memory as a [`Float64Array`][mdn-float64array]. +- **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, + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var A = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + +dsyr( '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 ] +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + + + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +// Initial arrays... +var x0 = new Float64Array( [ 1.0, 1.0, 1.0, 1.0 ] ); +var A = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); + +// Create offset views... +var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +dsyr( '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 ] +``` + +#### dsyr.ndarray( uplo, N, α, x, sx, ox, A, sa1, sa2, oa ) + +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. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var A = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); +var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + +dsyr.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 ] +``` + +The function has the following additional parameters: + +- **ox**: starting index for `x`. +- **sa1**: stride of the first dimension of `A`. +- **sa2**: stride of the second dimension of `A`. +- **oa**: starting index for `A`. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var A = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] ); +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + +dsyr.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 ] +``` + +
+ + + +
+ +## Notes + +- `dsyr()` corresponds to the [BLAS][blas] level 2 function [`dsyr`][blas-dsyr]. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ones = require( '@stdlib/array/ones' ); +var dsyr = require( '@stdlib/blas/base/dsyr' ); + +var opts = { + 'dtype': 'float64' +}; + +var N = 3; + +var A = ones( N*N, opts.dtype ); +var x = discreteUniform( N, -10.0, 10.0, opts ); + +dsyr( 'row-major', 'upper', 3, 1.0, x, 1, A, 3 ); +console.log( A ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +TODO +``` + +#### TODO + +TODO. + +```c +TODO +``` + +TODO + +```c +TODO +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +TODO +``` + +
+ + + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/dsyr/benchmark/benchmark.js new file mode 100644 index 00000000000..d8b526ca468 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/benchmark/benchmark.js @@ -0,0 +1,104 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +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; +var dsyr = require( './../lib/dsyr.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} N - number of elements along each dimension +* @returns {Function} benchmark function +*/ +function createBenchmark( N ) { + var x = ones( N, options.dtype ); + var A = ones( N*N, options.dtype ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var z; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = dsyr( 'row-major', 'upper', N, 1.0, x, 1, A, N ); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var min; + var max; + var N; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + 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 ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/dsyr/benchmark/benchmark.ndarray.js new file mode 100644 index 00000000000..7d1a7e3c9ad --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/benchmark/benchmark.ndarray.js @@ -0,0 +1,104 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +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; +var dsyr = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} N - number of elements along each dimension +* @returns {Function} benchmark function +*/ +function createBenchmark( N ) { + var x = ones( N, options.dtype ); + var A = ones( N*N, options.dtype ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var z; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = dsyr( 'upper', N, 1.0, x, 1, 0, A, N, 1, 0 ); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var min; + var max; + var N; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); + f = createBenchmark( N ); + bench( pkg+':ndarray:size='+(N*N), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/dsyr/docs/repl.txt new file mode 100644 index 00000000000..b417cd9e60c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/docs/repl.txt @@ -0,0 +1,110 @@ + +{{alias}}( 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. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + If `N` is equal to `0` or `α` is equal to `0`, the function returns `A` + unchanged. + + Parameters + ---------- + order: string + Row-major (C-style) or column-major (Fortran-style) order. Must be + either 'row-major' or 'column-major'. + + uplo: string + Specifies whether to reference the upper or lower triangular part of + `A`. Must be either 'upper' or 'lower'. + + N: integer + Number of elements along each dimension of `A`. + + α: number + Scalar constant. + + x: Float64Array + Input vector. + + sx: integer + Index increment for `x`. + + A: Float64Array + Input matrix. + + lda: integer + Stride of the first dimension of `A` (a.k.a., leading dimension of the + matrix `A`). + + Returns + ------- + A: Float64Array + Input matrix. + + Examples + -------- + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0 ] ); + > var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 0.0, 2.0 ] ); + > {{alias}}( 'row-major', 'upper', 2, 1.0, x, 1, A, 2 ) + [ 2.0, 3.0, 0.0, 3.0 ] + + +{{alias}}.ndarray( uplo, N, α, x, sx, ox, A, sa1, sa2, oa ) + 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. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + uplo: string + Specifies whether to reference the upper or lower triangular part of + `A`. Must be either 'upper' or 'lower'. + + N: integer + Number of elements along each dimension of `A`. + + α: number + Scalar constant. + + x: Float64Array + Input vector. + + sx: integer + Index increment for `x`. + + ox: integer + Starting index for `x`. + + A: Float64Array + Input matrix. + + sa1: integer + Stride of the first dimension of `A`. + + sa2: integer + Stride of the second dimension of `A`. + + oa: integer + Starting index for `A`. + + Returns + ------- + A: Float64Array + Input matrix. + + Examples + -------- + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0 ] ); + > var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 0.0, 2.0 ] ); + > {{alias}}.ndarray( 'upper', 2, 1.0, x, 1, 0, A, 2, 1, 0 ) + [ 2.0, 3.0, 0.0, 3.0 ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/dsyr/docs/types/index.d.ts new file mode 100644 index 00000000000..66d7e1cd0ea --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/docs/types/index.d.ts @@ -0,0 +1,117 @@ +/* +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { Layout, MatrixTriangle } from '@stdlib/types/blas'; + +/** +* Interface describing `dsyr`. +*/ +interface Routine { + /** + * 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 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` + * @param alpha - scalar constant + * @param x - input vector + * @param strideX - `x` stride length + * @param A - matrix + * @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) + * @returns `A` + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var A = new Float64Array( [ 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 x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + * + * dsyr( '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 ] + */ + ( order: Layout, uplo: MatrixTriangle, N: number, alpha: number, x: Float64Array, strideX: number, A: Float64Array, LDA: number ): Float64Array; + + /** + * Performs the matrix-vector operation `y = alpha*A*x + beta*y` using alternative indexing semantics and where `alpha` and `beta` are scalars, `x` and `y` are `N` element vectors, and `A` is an `N` by `N` symmetric matrix. + * + * @param order - 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 in the matrix `A` + * @param alpha - scalar constant + * @param x - input vector + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param A - matrix + * @param strideA1 - stride of the first dimension of `A` + * @param strideA2 - stride of the second dimension of `A` + * @param offsetA - starting index for `A` + * @returns `A` + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var A = new Float64Array( [ 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 x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + * + * dsyr.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 ] + */ + ndarray( uplo: MatrixTriangle, N: number, alpha: number, x: Float64Array, strideX: number, offsetX: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number ): Float64Array; +} + +/** +* 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 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` +* @param alpha - scalar constant +* @param x - input vector +* @param strideX - `x` stride length +* @param A - matrix +* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) +* @returns `A` +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new Float64Array( [ 1.0, 1.0, 1.0, 0.0, 2.0, 2.0, 0.0, 0.0, 3.0 ] ); +* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* +* dsyr( '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 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new Float64Array( [ 1.0, 1.0, 1.0, 0.0, 2.0, 2.0, 0.0, 0.0, 3.0 ] ); +* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* +* dsyr.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 ] +*/ +declare var dsyr: Routine; + + +// EXPORTS // + +export = dsyr; diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/dsyr/docs/types/test.ts new file mode 100644 index 00000000000..0b028410677 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/docs/types/test.ts @@ -0,0 +1,342 @@ +/* +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +import dsyr = require( './index' ); + + +// TESTS // + +// The function returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, 10 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the function is provided a first argument which is not a string... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr( 10, 'upper', 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( true, 'upper', 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( false, 'upper', 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( null, 'upper', 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( undefined, 'upper', 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( [], 'upper', 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( {}, 'upper', 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( ( x: number ): number => x, 'upper', 10, 1.0, x, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a string... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr( 'row-major', 10, 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', true, 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', false, 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', null, 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', undefined, 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', [ '1' ], 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', {}, 10, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', ( x: number ): number => x, 10, 1.0, x, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr( 'row-major', 'upper', '10', 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', true, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', false, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', null, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', undefined, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', [], 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', {}, 1.0, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', ( x: number ): number => x, 1.0, x, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr( 'row-major', 'upper', 10, '10', x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, true, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, false, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, null, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, undefined, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, [], x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, {}, x, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, ( x: number ): number => x, x, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a Float64Array... +{ + const A = new Float64Array( 20 ); + + dsyr( 'row-major', 'upper', 10, 1.0, 10, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, '10', 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, true, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, false, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, null, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, undefined, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, [ '1' ], 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, {}, 1, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, ( x: number ): number => x, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr( 'row-major', 'upper', 10, 1.0, x, '10', A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, true, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, false, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, null, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, undefined, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, [], A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, {}, A, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, ( x: number ): number => x, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a seventh argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, 10, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, '10', 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, true, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, false, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, null, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, undefined, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, [ '1' ], 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, {}, 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, ( x: number ): number => x, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided an eighth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, '10' ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, true ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, false ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, null ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, undefined ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, [] ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, {} ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr(); // $ExpectError + dsyr( 'row-major' ); // $ExpectError + dsyr( 'row-major', 'upper' ); // $ExpectError + dsyr( 'row-major', 'upper', 10 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1 ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A ); // $ExpectError + dsyr( 'row-major', 'upper', 10, 1.0, x, 1, A, 10, 1 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the function is provided a first argument which is not a string... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray( 10, 10, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( true, 10, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( false, 10, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( null, 10, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( undefined, 10, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( [ '1' ], 10, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( {}, 10, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( ( x: number ): number => x, 10, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray( 'upper', '10', 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', true, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', false, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', null, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', undefined, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', [], 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', {}, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', ( x: number ): number => x, 1.0, x, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray( 'upper', 10, '10', x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, true, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, false, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, null, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, undefined, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, [], x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, {}, x, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, ( x: number ): number => x, x, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Float64Array... +{ + const A = new Float64Array( 20 ); + + dsyr.ndarray( 'upper', 10, 1.0, 10, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, '10', 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, true, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, false, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, null, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, undefined, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, [ '1' ], 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, {}, 1, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, ( x: number ): number => x, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray( 'upper', 10, 1.0, x, '10', 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, true, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, false, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, null, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, undefined, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, [], 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, {}, 0, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, ( x: number ): number => x, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray( 'upper', 10, 1.0, x, 1, '10', A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, true, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, false, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, null, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, undefined, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, [], A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, {}, A, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, ( x: number ): number => x, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a seventh argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, 10, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, '10', 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, true, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, false, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, null, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, undefined, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, [ '1' ], 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, {}, 10, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, ( x: number ): number => x, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided an eighth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, '10', 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, true, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, false, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, null, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, undefined, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, [], 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, {}, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a ninth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, '10', 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, true, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, false, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, null, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, undefined, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, [], 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, {}, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a tenth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, '10' ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, true ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, false ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, null ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, undefined ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, [] ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, {} ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dsyr.ndarray(); // $ExpectError + dsyr.ndarray( 'upper' ); // $ExpectError + dsyr.ndarray( 'upper', 10 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1 ); // $ExpectError + dsyr.ndarray( 'upper', 10, 1.0, x, 1, 0, A, 10, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/examples/index.js b/lib/node_modules/@stdlib/blas/base/dsyr/examples/index.js new file mode 100644 index 00000000000..198ebb4ad19 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/examples/index.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +'use strict'; + +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ones = require( '@stdlib/array/ones' ); +var dsyr = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; + +var N = 3; + +var A = ones( N*N, opts.dtype ); +var x = discreteUniform( N, -10.0, 10.0, opts ); + +dsyr( 'row-major', 'upper', 3, 1.0, x, 1, A, 3 ); +console.log( A ); diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/lib/base.js b/lib/node_modules/@stdlib/blas/base/dsyr/lib/base.js new file mode 100644 index 00000000000..bdc56a39a98 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/lib/base.js @@ -0,0 +1,115 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +'use strict'; + +// MODULES // + +var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major' ); + + +// MAIN // + +/** +* 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. +* +* @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 {Float64Array} x - input vector +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @param {Float64Array} A - input matrix +* @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` +* @returns {Float64Array} `A` +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new Float64Array( [ 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 x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* +* dsyr( '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 ] +*/ +function dsyr( uplo, N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offsetA ) { // eslint-disable-line max-len + var isrm; + var tmp; + var ix0; + var ix1; + var sa0; + var sa1; + var i0; + var i1; + var oa; + var ox; + + isrm = isRowMajor( [ strideA1, strideA2 ] ); + 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 === 'upper' ) || + ( isrm && uplo === 'lower' ) + ) { + ix1 = ox; + for ( i1 = 0; i1 < N; i1++ ) { + if ( x[ ix1 ] !== 0.0 ) { + 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; + } + return A; + } + // ( isrm && uplo === 'upper' ) || ( !isrm && uplo === 'lower' ) + ix1 = ox; + for ( i1 = 0; i1 < N; i1++ ) { + if ( x[ ix1 ] !== 0.0 ) { + 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; + } + return A; +} + + +// EXPORTS // + +module.exports = dsyr; diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/lib/dsyr.js b/lib/node_modules/@stdlib/blas/base/dsyr/lib/dsyr.js new file mode 100644 index 00000000000..2f6f395661a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/lib/dsyr.js @@ -0,0 +1,97 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +'use strict'; + +// MODULES // + +var max = require( '@stdlib/math/base/special/fast/max' ); +var isLayout = require( '@stdlib/blas/base/assert/is-layout' ); +var isMatrixTriangle = require( '@stdlib/blas/base/assert/is-matrix-triangle' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var format = require( '@stdlib/string/format' ); +var base = require( './base.js' ); + + +// MAIN // + +/** +* 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 {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 {Float64Array} x - input vector +* @param {integer} strideX - `x` stride length +* @param {Float64Array} 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 {Float64Array} `A` +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new Float64Array( [ 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 x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* +* dsyr( '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 ] +*/ +function dsyr( order, uplo, N, alpha, x, strideX, A, LDA ) { + var sa1; + var sa2; + var ox; + + 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 ) ); + } + if ( N === 0 || alpha === 0.0 ) { + return A; + } + if ( order === 'column-major' ) { + sa1 = 1; + sa2 = LDA; + } else { // order === 'row-major' + sa1 = LDA; + sa2 = 1; + } + ox = stride2offset( N, strideX ); + return base( uplo, N, alpha, x, strideX, ox, A, sa1, sa2, 0 ); +} + + +// EXPORTS // + +module.exports = dsyr; diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/lib/index.js b/lib/node_modules/@stdlib/blas/base/dsyr/lib/index.js new file mode 100644 index 00000000000..3275f78309c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/lib/index.js @@ -0,0 +1,70 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +'use strict'; + +/** +* BLAS level 2 routine to perform 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. +* +* @module @stdlib/blas/base/dsyr +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dsyr = require( '@stdlib/blas/base/dsyr' ); +* +* var A = new Float64Array( [ 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 x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* +* dsyr( '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 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dsyr = require( '@stdlib/blas/base/dsyr' ); +* +* var A = new Float64Array( [ 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 x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* +* dsyr.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 ] +*/ + +// MODULES // + +var join = require( 'path' ).join; +var tryRequire = require( '@stdlib/utils/try-require' ); +var isError = require( '@stdlib/assert/is-error' ); +var main = require( './main.js' ); + + +// MAIN // + +var dsyr; +var tmp = tryRequire( join( __dirname, './native.js' ) ); +if ( isError( tmp ) ) { + dsyr = main; +} else { + dsyr = tmp; +} + + +// EXPORTS // + +module.exports = dsyr; + +// exports: { "ndarray": "dsyr.ndarray" } diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/lib/main.js b/lib/node_modules/@stdlib/blas/base/dsyr/lib/main.js new file mode 100644 index 00000000000..2e9caa4691c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/lib/main.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +'use strict'; + +// MODULES // + +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var dsyr = require( './dsyr.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( dsyr, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = dsyr; diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/dsyr/lib/ndarray.js new file mode 100644 index 00000000000..490056e2b0e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/lib/ndarray.js @@ -0,0 +1,76 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +'use strict'; + +// MODULES // + +var isMatrixTriangle = require( '@stdlib/blas/base/assert/is-matrix-triangle' ); +var format = require( '@stdlib/string/format' ); +var base = require( './base.js' ); + + +// MAIN // + +/** +* 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 {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 {Float64Array} x - input vector +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @param {Float64Array} A - input matrix +* @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 +* @returns {Float64Array} `A` +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new Float64Array( [ 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 x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* +* dsyr( '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 ] +*/ +function dsyr( 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 ( N === 0 || alpha === 0.0 ) { + return A; + } + return base( uplo, N, alpha, x, strideX, offsetX, A, strideA1, strideA2, offsetA ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = dsyr; diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/package.json b/lib/node_modules/@stdlib/blas/base/dsyr/package.json new file mode 100644 index 00000000000..9c3c693ea93 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/package.json @@ -0,0 +1,68 @@ +{ + "name": "@stdlib/blas/base/dsyr", + "version": "0.0.0", + "description": "Perform the symmetric rank 1 operation `A = α*x*x^T + A`.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "level 2", + "dsyr", + "linear", + "algebra", + "subroutines", + "array", + "ndarray", + "float64", + "double", + "float64array" + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_complex_access_pattern.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_complex_access_pattern.json new file mode 100644 index 00000000000..981b891e4c3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_complex_access_pattern.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": -1, + "offsetX": 2, + "A": [ 999.0, 999.0, 999.0, 999.0, 999.0, 1.0, 999.0, 2.0, 999.0, 3.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 1.0, 999.0, 2.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 0.0, 999.0, 1.0 ], + "strideA1": -2, + "strideA2": -10, + "offsetA": 29, + "A_out": [ 999.0, 999.0, 999.0, 999.0, 999.0, 2.0, 999.0, 4.0, 999.0, 6.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 5.0, 999.0, 8.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 0.0, 999.0, 10.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_l.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_l.json new file mode 100644 index 00000000000..389657f34ae --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_l.json @@ -0,0 +1,15 @@ +{ + "order": "column-major", + "uplo": "lower", + "N": 3, + "alpha": 2.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 1.0, 1.0, 1.0, 0.0, 2.0, 2.0, 0.0, 0.0, 3.0 ], + "lda": 3, + "strideA1": 1, + "strideA2": 3, + "offsetA": 0, + "A_out": [ 3.0, 5.0, 7.0, 0.0, 10.0, 14.0, 0.0, 0.0, 21.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_oa.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_oa.json new file mode 100644 index 00000000000..3ba11130094 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_oa.json @@ -0,0 +1,13 @@ +{ + "uplo": "lower", + "N": 3, + "alpha": 2.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 1.0, 1.0, 1.0, 999.0, 999.0, 0.0, 2.0, 2.0, 999.0, 999.0, 0.0, 0.0, 3.0, 999.0 ], + "strideA1": 1, + "strideA2": 5, + "offsetA": 1, + "A_out": [ 999.0, 3.0, 5.0, 7.0, 999.0, 999.0, 0.0, 10.0, 14.0, 999.0, 999.0, 0.0, 0.0, 21.0, 999.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1_sa2.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1_sa2.json new file mode 100644 index 00000000000..c5ab8a57e72 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1_sa2.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 999.0, 999.0, 999.0, 999.0, 1.0, 999.0, 0.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 2.0, 999.0, 1.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 3.0, 999.0, 2.0, 999.0, 1.0 ], + "strideA1": 2, + "strideA2": 10, + "offsetA": 5, + "A_out": [ 999.0, 999.0, 999.0, 999.0, 999.0, 2.0, 999.0, 0.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 4.0, 999.0, 5.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 6.0, 999.0, 8.0, 999.0, 10.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1_sa2n.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1_sa2n.json new file mode 100644 index 00000000000..9f5de627240 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1_sa2n.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 999.0, 999.0, 999.0, 999.0, 3.0, 999.0, 2.0, 999.0, 1.0, 999.0, 999.0, 999.0, 999.0, 999.0, 2.0, 999.0, 1.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 1.0, 999.0, 0.0, 999.0, 0.0 ], + "strideA1": 2, + "strideA2": -10, + "offsetA": 25, + "A_out": [ 999.0, 999.0, 999.0, 999.0, 999.0, 6.0, 999.0, 8.0, 999.0, 10.0, 999.0, 999.0, 999.0, 999.0, 999.0, 4.0, 999.0, 5.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 2.0, 999.0, 0.0, 999.0, 0.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1n_sa2.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1n_sa2.json new file mode 100644 index 00000000000..ed222434544 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1n_sa2.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 0.0, 999.0, 1.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 1.0, 999.0, 2.0, 999.0, 999.0, 999.0, 999.0, 999.0, 1.0, 999.0, 2.0, 999.0, 3.0 ], + "strideA1": -2, + "strideA2": 10, + "offsetA": 9, + "A_out": [ 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 0.0, 999.0, 2.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 5.0, 999.0, 4.0, 999.0, 999.0, 999.0, 999.0, 999.0, 10.0, 999.0, 8.0, 999.0, 6.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1n_sa2n.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1n_sa2n.json new file mode 100644 index 00000000000..651cfb6ad85 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_sa1n_sa2n.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 999.0, 999.0, 999.0, 999.0, 1.0, 999.0, 2.0, 999.0, 3.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 1.0, 999.0, 2.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 0.0, 999.0, 1.0 ], + "strideA1": -2, + "strideA2": -10, + "offsetA": 29, + "A_out": [ 999.0, 999.0, 999.0, 999.0, 999.0, 10.0, 999.0, 8.0, 999.0, 6.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 5.0, 999.0, 4.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 0.0, 999.0, 2.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_u.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_u.json new file mode 100644 index 00000000000..58f2411c7be --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_u.json @@ -0,0 +1,15 @@ +{ + "order": "column-major", + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 1.0, 0.0, 0.0, 2.0, 1.0, 0.0, 3.0, 2.0, 1.0 ], + "lda": 3, + "strideA1": 1, + "strideA2": 3, + "offsetA": 0, + "A_out": [ 2.0, 0.0, 0.0, 4.0, 5.0, 0.0, 6.0, 8.0, 10.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_xn.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_xn.json new file mode 100644 index 00000000000..7f2bcd4c3de --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_xn.json @@ -0,0 +1,15 @@ +{ + "order": "column-major", + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0, 4.0, 5.0 ], + "strideX": -2, + "offsetX": 4, + "A": [ 1.0, 0.0, 0.0, 2.0, 1.0, 0.0, 3.0, 2.0, 1.0 ], + "lda": 3, + "strideA1": 1, + "strideA2": 3, + "offsetA": 0, + "A_out": [ 26.0, 0.0, 0.0, 17.0, 10.0, 0.0, 8.0, 5.0, 2.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_xp.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_xp.json new file mode 100644 index 00000000000..92c08879256 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/column_major_xp.json @@ -0,0 +1,15 @@ +{ + "order": "column-major", + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0, 4.0, 5.0 ], + "strideX": 2, + "offsetX": 0, + "A": [ 1.0, 0.0, 0.0, 2.0, 1.0, 0.0, 3.0, 2.0, 1.0 ], + "lda": 3, + "strideA1": 1, + "strideA2": 3, + "offsetA": 0, + "A_out": [ 2.0, 0.0, 0.0, 5.0, 10.0, 0.0, 8.0, 17.0, 26.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_complex_access_pattern.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_complex_access_pattern.json new file mode 100644 index 00000000000..68d3224c684 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_complex_access_pattern.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": -1, + "offsetX": 2, + "A": [ 999.0, 1.0, 999.0, 0.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 2.0, 999.0, 1.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 3.0, 999.0, 2.0, 999.0, 1.0, 999.0 ], + "strideA1": -14, + "strideA2": -2, + "offsetA": 33, + "A_out": [ 999.0, 2.0, 999.0, 0.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 4.0, 999.0, 5.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 6.0, 999.0, 8.0, 999.0, 10.0, 999.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_l.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_l.json new file mode 100644 index 00000000000..97b9c6b1226 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_l.json @@ -0,0 +1,15 @@ +{ + "order": "row-major", + "uplo": "lower", + "N": 3, + "alpha": 2.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 1.0, 0.0, 0.0, 1.0, 2.0, 0.0, 1.0, 2.0, 3.0 ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 3.0, 0.0, 0.0, 5.0, 10.0, 0.0, 7.0, 14.0, 21.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_oa.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_oa.json new file mode 100644 index 00000000000..6f31e049fb3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_oa.json @@ -0,0 +1,13 @@ +{ + "uplo": "lower", + "N": 3, + "alpha": 2.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 999.0, 999.0, 1.0, 0.0, 0.0, 1.0, 2.0, 0.0, 1.0, 2.0, 3.0, 999.0, 999.0, 999.0 ], + "strideA1": 3, + "strideA2": 1, + "offsetA": 3, + "A_out": [ 999.0, 999.0, 999.0, 3.0, 0.0, 0.0, 5.0, 10.0, 0.0, 7.0, 14.0, 21.0, 999.0, 999.0, 999.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1_sa2.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1_sa2.json new file mode 100644 index 00000000000..02b637c5d58 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1_sa2.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 1.0, 999.0, 2.0, 999.0, 3.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 1.0, 999.0, 2.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 0.0, 999.0, 1.0, 999.0 ], + "strideA1": 14, + "strideA2": 2, + "offsetA": 1, + "A_out": [ 999.0, 2.0, 999.0, 4.0, 999.0, 6.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 5.0, 999.0, 8.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 0.0, 999.0, 10.0, 999.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1_sa2n.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1_sa2n.json new file mode 100644 index 00000000000..4c53cadd7f0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1_sa2n.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 3.0, 999.0, 2.0, 999.0, 1.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 2.0, 999.0, 1.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 1.0, 999.0, 0.0, 999.0, 0.0, 999.0 ], + "strideA1": 14, + "strideA2": -2, + "offsetA": 5, + "A_out": [ 999.0, 6.0, 999.0, 4.0, 999.0, 2.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 8.0, 999.0, 5.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 10.0, 999.0, 0.0, 999.0, 0.0, 999.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1n_sa2.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1n_sa2.json new file mode 100644 index 00000000000..c942623c982 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1n_sa2.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 0.0, 999.0, 0.0, 999.0, 1.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 1.0, 999.0, 2.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 1.0, 999.0, 2.0, 999.0, 3.0, 999.0 ], + "strideA1": -14, + "strideA2": 2, + "offsetA": 29, + "A_out": [ 999.0, 0.0, 999.0, 0.0, 999.0, 10.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 0.0, 999.0, 5.0, 999.0, 8.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 2.0, 999.0, 4.0, 999.0, 6.0, 999.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1n_sa2n.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1n_sa2n.json new file mode 100644 index 00000000000..0f0160506cf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_sa1n_sa2n.json @@ -0,0 +1,13 @@ +{ + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 999.0, 1.0, 999.0, 0.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 2.0, 999.0, 1.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 3.0, 999.0, 2.0, 999.0, 1.0, 999.0 ], + "strideA1": -14, + "strideA2": -2, + "offsetA": 33, + "A_out": [ 999.0, 10.0, 999.0, 0.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 8.0, 999.0, 5.0, 999.0, 0.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 999.0, 6.0, 999.0, 4.0, 999.0, 2.0, 999.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_u.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_u.json new file mode 100644 index 00000000000..fd23d63a4fb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_u.json @@ -0,0 +1,15 @@ +{ + "order": "row-major", + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0 ], + "strideX": 1, + "offsetX": 0, + "A": [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 2.0, 4.0, 6.0, 0.0, 5.0, 8.0, 0.0, 0.0, 10.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_xn.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_xn.json new file mode 100644 index 00000000000..9bb9da9839b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_xn.json @@ -0,0 +1,15 @@ +{ + "order": "row-major", + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0, 4.0, 5.0 ], + "strideX": -2, + "offsetX": 4, + "A": [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 26.0, 17.0, 8.0, 0.0, 10.0, 5.0, 0.0, 0.0, 2.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_xp.json b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_xp.json new file mode 100644 index 00000000000..2967b1af66c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/fixtures/row_major_xp.json @@ -0,0 +1,15 @@ +{ + "order": "row-major", + "uplo": "upper", + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 2.0, 3.0, 4.0, 5.0 ], + "strideX": 2, + "offsetX": 0, + "A": [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 2.0, 5.0, 8.0, 0.0, 10.0, 17.0, 0.0, 0.0, 26.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/test.dsyr.js b/lib/node_modules/@stdlib/blas/base/dsyr/test/test.dsyr.js new file mode 100644 index 00000000000..4affab6c33f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/test.dsyr.js @@ -0,0 +1,448 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +/* eslint-disable max-len */ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var dsyr = require( './../lib/dsyr.js' ); + + +// FIXTURES // + +var ru = require( './fixtures/row_major_u.json' ); +var rl = require( './fixtures/row_major_l.json' ); +var rxp = require( './fixtures/row_major_xp.json' ); +var rxn = require( './fixtures/row_major_xn.json' ); + +var cu = require( './fixtures/column_major_u.json' ); +var cl = require( './fixtures/column_major_l.json' ); +var cxp = require( './fixtures/column_major_xp.json' ); +var cxn = require( './fixtures/column_major_xn.json' ); + + +// FUNCTIONS // + +/** +* Tests for element-wise approximate equality. +* +* @private +* @param {Object} t - test object +* @param {Collection} actual - actual values +* @param {Collection} expected - expected values +* @param {number} rtol - relative tolerance +*/ +function isApprox( t, actual, expected, rtol ) { + var delta; + var tol; + var i; + + t.strictEqual( actual.length, expected.length, 'returns expected value' ); + for ( i = 0; i < expected.length; i++ ) { + if ( actual[ i ] === expected[ i ] ) { + t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); + } else { + delta = abs( actual[ i ] - expected[ i ] ); + tol = rtol * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dsyr, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 8', function test( t ) { + t.strictEqual( dsyr.length, 8, 'returns expected value' ); + t.end(); +}); + +tape( 'the function throws an error if provided an invalid first argument', 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() { + dsyr( value, data.uplo, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.A ), data.lda ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid second argument', 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() { + dsyr( data.order, value, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.A ), data.lda ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid third argument', 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() { + dsyr( data.order, data.uplo, value, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.A ), data.lda ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid sixth argument', 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() { + dsyr( data.order, data.uplo, data.N, data.alpha, new Float64Array( data.x ), value, new Float64Array( data.A ), data.lda ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid eighth argument', 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() { + dsyr( data.order, data.uplo, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.A ), value ); + }; + } +}); + +tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (row-major, upper)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = ru; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (column-major, upper)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cu; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (row-major, lower)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rl; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (column-major, lower)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cl; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function returns a reference to the input matrix `A`', function test( t ) { + var data; + var out; + var a; + var x; + + data = ru; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + out = dsyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `N` is zero or the scalar constant is zero, the function returns the input matrix `A` unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rl; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A ); + + out = dsyr( 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 = dsyr( 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' ); + + t.end(); +}); + +tape( 'if `N` is zero or the scalar constant is zero, the function returns the input matrix `A` unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cl; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A ); + + out = dsyr( 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 = dsyr( 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' ); + + t.end(); +}); + +tape( 'the function supports specifying an `x` stride (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rxp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying an `x` stride (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cxp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rxn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cxn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( data.order, data.uplo, data.N, data.alpha, x, data.strideX, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/test.js b/lib/node_modules/@stdlib/blas/base/dsyr/test/test.js new file mode 100644 index 00000000000..62f344c6d4f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/test.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var proxyquire = require( 'proxyquire' ); +var IS_BROWSER = require( '@stdlib/assert/is-browser' ); +var dsyr = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': IS_BROWSER +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dsyr, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'attached to the main export is a method providing an ndarray interface', function test( t ) { + t.strictEqual( typeof dsyr.ndarray, 'function', 'method is a function' ); + t.end(); +}); + +tape( 'if a native implementation is available, the main export is the native implementation', opts, function test( t ) { + var dsyr = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dsyr, mock, 'returns expected value' ); + t.end(); + + function tryRequire() { + return mock; + } + + function mock() { + // Mock... + } +}); + +tape( 'if a native implementation is not available, the main export is a JavaScript implementation', opts, function test( t ) { + var dsyr; + var main; + + main = require( './../lib/dsyr.js' ); + + dsyr = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dsyr, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/blas/base/dsyr/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/dsyr/test/test.ndarray.js new file mode 100644 index 00000000000..b63cc69100f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dsyr/test/test.ndarray.js @@ -0,0 +1,658 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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. +*/ + +/* eslint-disable max-len */ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var dsyr = require( './../lib/ndarray.js' ); + + +// FIXTURES // + +var ru = require( './fixtures/row_major_u.json' ); +var rl = require( './fixtures/row_major_l.json' ); +var rxp = require( './fixtures/row_major_xp.json' ); +var rxn = require( './fixtures/row_major_xn.json' ); +var roa = require( './fixtures/row_major_oa.json' ); +var rsa1sa2 = require( './fixtures/row_major_sa1_sa2.json' ); +var rsa1nsa2 = require( './fixtures/row_major_sa1n_sa2.json' ); +var rsa1sa2n = require( './fixtures/row_major_sa1_sa2n.json' ); +var rsa1nsa2n = require( './fixtures/row_major_sa1n_sa2n.json' ); +var rcap = require( './fixtures/row_major_complex_access_pattern.json' ); + +var cu = require( './fixtures/column_major_u.json' ); +var cl = require( './fixtures/column_major_l.json' ); +var cxp = require( './fixtures/column_major_xp.json' ); +var cxn = require( './fixtures/column_major_xn.json' ); +var coa = require( './fixtures/column_major_oa.json' ); +var csa1sa2 = require( './fixtures/column_major_sa1_sa2.json' ); +var csa1nsa2 = require( './fixtures/column_major_sa1n_sa2.json' ); +var csa1sa2n = require( './fixtures/column_major_sa1_sa2n.json' ); +var csa1nsa2n = require( './fixtures/column_major_sa1n_sa2n.json' ); +var ccap = require( './fixtures/column_major_complex_access_pattern.json' ); + + +// FUNCTIONS // + +/** +* Tests for element-wise approximate equality. +* +* @private +* @param {Object} t - test object +* @param {Collection} actual - actual values +* @param {Collection} expected - expected values +* @param {number} rtol - relative tolerance +*/ +function isApprox( t, actual, expected, rtol ) { + var delta; + var tol; + var i; + + t.strictEqual( actual.length, expected.length, 'returns expected value' ); + for ( i = 0; i < expected.length; i++ ) { + if ( actual[ i ] === expected[ i ] ) { + t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); + } else { + delta = abs( actual[ i ] - expected[ i ] ); + tol = rtol * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dsyr, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 10', function test( t ) { + t.strictEqual( dsyr.length, 10, 'returns expected value' ); + t.end(); +}); + +tape( 'the function throws an error if provided an invalid first argument', 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() { + dsyr( value, data.N, data.alpha, new Float64Array( data.x ), data.strideX, data.offsetX, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid second argument', 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() { + dsyr( data.uplo, value, data.alpha, new Float64Array( data.x ), data.strideX, data.offsetX, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid fifth argument', 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() { + dsyr( data.uplo, data.N, data.alpha, new Float64Array( data.x ), value, data.offsetX, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (row-major, upper)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = ru; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (column-major, upper)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cu; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (row-major, lower)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rl; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function performs the symmetric rank 1 operation `A = α*x*x^T + A` (column-major, lower)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cl; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function returns a reference to the input matrix `A`', function test( t ) { + var data; + var out; + var a; + var x; + + data = ru; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + out = dsyr( 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(); +}); + +tape( 'if `N` is zero or the scalar constant is zero, the function returns the input matrix `A` unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rl; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A ); + + out = dsyr( 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 = dsyr( 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' ); + + t.end(); +}); + +tape( 'if `N` is zero or the scalar constant is zero, the function returns the input matrix `A` unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cl; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A ); + + out = dsyr( 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 = dsyr( 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' ); + + t.end(); +}); + +tape( 'the function supports specifying the strides of the first and second dimensions of `A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rsa1sa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying the strides of the first and second dimensions of `A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = csa1sa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports a negative stride for the first dimension of `A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rsa1nsa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports a negative stride for the first dimension of `A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = csa1nsa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports a negative stride for the second dimension of `A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rsa1sa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports a negative stride for the second dimension of `A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = csa1sa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports negative strides for both dimensions of `A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rsa1nsa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports negative strides for both dimensions of `A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = csa1nsa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying an `A` offset (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = roa; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying an `A` offset (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = coa; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying an `x` stride (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rxp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying an `x` stride (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cxp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rxn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = cxn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports complex access patterns (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = rcap; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +}); + +tape( 'the function supports complex access patterns (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + + data = ccap; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + + expected = new Float64Array( data.A_out ); + + out = dsyr( 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' ); + isApprox( t, a, expected, 2.0 ); + + t.end(); +});