From 847c6a168c482a5cec458697d6ef91f00a1a8b18 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Wed, 21 Aug 2024 18:20:06 +0530 Subject: [PATCH 1/6] feat: init base implementation --- .../@stdlib/lapack/base/dlasv2/lib/base.js | 247 ++++++++++++++++++ 1 file changed, 247 insertions(+) create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/lib/base.js diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/base.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/base.js new file mode 100644 index 00000000000..4f5f48c6821 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/base.js @@ -0,0 +1,247 @@ +/** +* @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-statements */ + +'use strict'; + +// MODULES // + +var signum = require( '@stdlib/math/base/special/signum' ); +var sqrt = require( '@stdlib/math/base/special/sqrt' ); +var abs = require( '@stdlib/math/base/special/abs' ); + + +// FUNCTIONS // + +/** +* Returns `x` multipled by `signum( y )`. +* +* @private +* @param {number} x - scalar element +* @param {number} y - scalar element +* @returns {number} computed value +* +* @example +* var out = sign( 1.0, -0.9 ); +* // out => -1.0 +*/ +function sign( x, y ) { + return x * signum( y ); +} + + +// MAIN // + +/** +* Computes singular value decomposition of a 2x2 triangular matrix. +* +* @private +* @param {number} F - the (0,0) element of matrix +* @param {number} G - the (0,1) element of matrix +* @param {number} H - the (1,1) element of matrix +* @param {Float64Array} out - output array containing `SSMIN`, `SSMAX`, `SNR`, `CSR`, `SNL`, and `CSL` respectively +* @param {integer} strideOut - stride length for `out` +* @param {NonNegativeInteger} offsetOut - starting index of `out` +* @returns {Float64Array} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var out = new Float64Array( 6 ); +* +* out = dlasv2( 2.0, 3.0, 4.0, out, 1, 0 ); +* // out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +*/ +function dlasv2( F, G, H, out, strideOut, offsetOut ) { + var gasmal; + var ssmin; + var ssmax; + var tsign; + var PMAX; + var swap; + var clt; + var crt; + var csl; + var csr; + var slt; + var snl; + var snr; + var srt; + var tmp; + var fa; + var ft; + var ga; + var gt; + var ha; + var ht; + var mm; + var tt; + var a; + var d; + var l; + var m; + var r; + var s; + var t; + + ft = F; + fa = abs( ft ); + ht = H; + ha = abs( ht ); + + // PMAX points to the maximum absolute element of matrix + + // PMAX = 1 if F largest in absolute values + + // PMAX = 2 if G largest in absolute values + + // PMAX = 3 if H largest in absolute values + + PMAX = 1; + swap = ha > fa; + if ( swap ) { + PMAX = 3; + tmp = ft; + ft = ht; + ht = tmp; + tmp = fa; + fa = ha; + ha = tmp; + + // Now FA >= HA + } + gt = G; + ga = abs( gt ); + if ( ga === 0.0 ) { + // Diagonal matrix + ssmin = ha; + ssmax = fa; + clt = 1.0; + crt = 1.0; + slt = 0.0; + srt = 0.0; + } else { + gasmal = true; + if ( ga > fa ) { + PMAX = 2; + + // TODO: replace 1.11022302E-16 with dlamch( 'E' ) + if ( ( fa / ga ) < 1.11022302E-16 ) { + // Case of very large GA + gasmal = false; + ssmax = ga; + if ( ha > 1.0 ) { + ssmin = fa / ( ga / ha ); + } else { + ssmin = ( fa / ga ) * ha; + } + clt = 1.0; + slt = ht / gt; + srt = 1.0; + crt = ft / gt; + } + } + if ( gasmal === true ) { + // Normal case + d = fa - ha; + if ( d === fa ) { + // Copes with infinte F or H + l = 1.0; + } else { + l = d / fa; + } + + // Note that 0 < l < 1 + m = gt / ft; + + // Note that abs( m ) < 1 / macheps + t = 2.0 - l; + + // Note that T > 1 + mm = m * m; + tt = t * t; + s = sqrt( tt + mm ); + + // Note that 1 < S < 1 + 1 / macheps + if ( l === 0.0 ) { + r = abs( m ); + } else { + r = sqrt( ( l * l ) + mm ); + } + + // Note that 0 < R < 1 + 1 / macheps + a = 0.5 * ( s + r); + + // Note that 1 < A < 1 + abs( m ) + ssmin = ha / a; + ssmax = fa * a; + if ( mm === 0.0 ) { + // Note that M is very tiny + if ( l === 0.0 ) { + t = sign( 2.0, ft ) * sign( 1.0, gt ); + } else { + t = ( ( gt / sign( d, ft ) ) + ( m / t ) ); + } + } else { + t = ( ( m / ( s + t ) ) + ( m / ( r + l ) ) ) * ( 1.0 + a ); + } + l = sqrt( ( t * t ) + 4.0 ); + crt = 2.0 / l; + srt = t / l; + clt = ( crt + ( srt * m ) ) / a; + slt = ( ht / ft ) * ( srt / a ); + } + } + if ( swap ) { + csl = srt; + snl = crt; + csr = slt; + snr = clt; + } else { + csl = clt; + snl = slt; + csr = crt; + snr = srt; + } + + // Correct signs 0f ssmax and ssmin + if ( PMAX === 1 ) { + tsign = sign( 1.0, csr ) * sign( 1.0, csl ) * sign( 1.0, F ); + } + if ( PMAX === 2 ) { + tsign = sign( 1.0, snr ) * sign( 1.0, csl ) * sign( 1.0, G ); + } + if ( PMAX === 3 ) { + tsign = sign( 1.0, snr ) * sign( 1.0, snl ) * sign( 1.0, H ); + } + ssmax = sign( ssmax, tsign ); + ssmin = sign( ssmin, tsign * sign( 1.0, F ) * sign( 1.0, H ) ); + + out[ offsetOut ] = ssmin; + out[ offsetOut + strideOut ] = ssmax; + out[ offsetOut + ( 2 * strideOut ) ] = snr; + out[ offsetOut + ( 3 * strideOut ) ] = csr; + out[ offsetOut + ( 4 * strideOut ) ] = snl; + out[ offsetOut + ( 5 * strideOut ) ] = csl; + return out; +} + + +// EXPORTS // + +module.exports = dlasv2; From 1b54010433b6b5c20a101b5dc93f44d46756f1ba Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Wed, 21 Aug 2024 18:23:13 +0530 Subject: [PATCH 2/6] feat: init public apis in lib --- .../@stdlib/lapack/base/dlasv2/lib/base.js | 2 +- .../@stdlib/lapack/base/dlasv2/lib/dlasv2.js | 51 +++++++++++++++++++ .../@stdlib/lapack/base/dlasv2/lib/main.js | 35 +++++++++++++ .../@stdlib/lapack/base/dlasv2/lib/ndarray.js | 51 +++++++++++++++++++ 4 files changed, 138 insertions(+), 1 deletion(-) create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/lib/dlasv2.js create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/lib/main.js create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/lib/ndarray.js diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/base.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/base.js index 4f5f48c6821..7bbce99903f 100644 --- a/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/base.js +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/base.js @@ -160,7 +160,7 @@ function dlasv2( F, G, H, out, strideOut, offsetOut ) { // Normal case d = fa - ha; if ( d === fa ) { - // Copes with infinte F or H + // Copes with infinite F or H l = 1.0; } else { l = d / fa; diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/dlasv2.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/dlasv2.js new file mode 100644 index 00000000000..0350ec64d25 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/dlasv2.js @@ -0,0 +1,51 @@ +/** +* @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 base = require( './base.js' ); + + +// MAIN // + +/** +* Computes singular value decomposition of a 2x2 triangular matrix. +* +* @param {number} F - the (0,0) element of matrix +* @param {number} G - the (0,1) element of matrix +* @param {number} H - the (1,1) element of matrix +* @param {Float64Array} out - output array containing `SSMIN`, `SSMAX`, `SNR`, `CSR`, `SNL`, and `CSL` respectively +* @returns {Float64Array} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var out = new Float64Array( 6 ); +* +* out = dlasv2( 2.0, 3.0, 4.0, out ); +* // out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +*/ +function dlasv2( F, G, H, out ) { + return base( F, G, H, out, 1, 0 ); +} + + +// EXPORTS // + +module.exports = dlasv2; diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/main.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/main.js new file mode 100644 index 00000000000..ca8687ef658 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/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 dlasv2 = require( './dlasv2.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( dlasv2, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = dlasv2; diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/ndarray.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/ndarray.js new file mode 100644 index 00000000000..f0d34d7ec6a --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/ndarray.js @@ -0,0 +1,51 @@ +/** +* @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 base = require( './base.js' ); + + +// MAIN // + +/** +* Computes singular value decomposition of a 2x2 triangular matrix using alternative indexing semantics. +* +* @param {number} F - the (0,0) element of matrix +* @param {number} G - the (0,1) element of matrix +* @param {number} H - the (1,1) element of matrix +* @param {Float64Array} out - output array containing `SSMIN`, `SSMAX`, `SNR`, `CSR`, `SNL`, and `CSL` respectively +* @param {integer} strideOut - stride length for `out` +* @param {NonNegativeInteger} offsetOut - starting index of `out` +* @returns {Float64Array} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var out = new Float64Array( 6 ); +* +* out = dlasv2( 2.0, 3.0, 4.0, out, 1, 0 ); +* // out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +*/ +var dlasv2 = base; + + +// EXPORTS // + +module.exports = dlasv2; From 14c0f384204d4414d9e34fc49106b75f57ce79d6 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Wed, 21 Aug 2024 18:56:21 +0530 Subject: [PATCH 3/6] docs: add README --- .../@stdlib/lapack/base/dlasv2/README.md | 224 ++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/README.md diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/README.md b/lib/node_modules/@stdlib/lapack/base/dlasv2/README.md new file mode 100644 index 00000000000..951666ccc00 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/README.md @@ -0,0 +1,224 @@ + + +# dlasv2 + +> Compute singular value decomposition of a 2x2 triangular matrix. + +
+ +## Usage + +```javascript +var dlasv2 = require( '@stdlib/lapack/base/dlasv2' ); +``` + +#### dlasv2( F, G, H, out ) + +Computes singular value decomposition of a 2x2 triangular matrix. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); +var out = new Float64Array( 6 ); + +out = dlasv2( 2.0, 3.0, 4.0, out ); +// out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +``` + +The function has the following parameters: + +- **F**: the (0,0) element of matrix. +- **G**: the (0,1) element of matrix. +- **H**: the (1,1) element of matrix. +- **out**: [`Float64Array`][mdn-float64array] output array containing `SSMIN`, `SSMAX`, `SNR`, `CSR`, `SNL`, and `CSL` respectively. + +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 OUT0 = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + +// Create offset views... +var OUT1 = new Float64Array( OUT0.buffer, OUT0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +dlasv2( 2.0, 3.0, 4.0, OUT1 ); +// OUT0 => [ 0.0, 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +``` + +#### dlasv2.ndarray( F, G, H, out, strideOut, offsetOut ) + +Computes singular value decomposition of a 2x2 triangular matrix using alternative indexing semantics. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); +var out = new Float64Array( 6 ); + +out = dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, 0 ); +// out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +``` + +The function has the following additional parameters: + +- **strideOut**: stride length for `Out`. +- **offsetOut**: starting index for `Out`. + +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 out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0] ); + +out = dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, 1 ); +// out => [ 0.0, 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +``` + +
+ + + +
+ +## Notes + +- `dlasv2()` corresponds to the [LAPACK][LAPACK] routine [`dlasv2`][lapack-dlasv2]. + +
+ + + +
+ +## Examples + + + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); +var dlasv2 = require( '@stdlib/lapack/base/dlasv2' ); + +var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + +out = dlasv2( 2.0, 3.0, 4.0, out ); +console.log( out ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +TODO +``` + +#### TODO + +TODO. + +```c +TODO +``` + +TODO + +```c +TODO +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +TODO +``` + +
+ + + +
+ + + + + + + + + + + + + + From 07aa24beb3ebd4c2e15811d1e310fb18bc4d369a Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Wed, 21 Aug 2024 19:03:06 +0530 Subject: [PATCH 4/6] docs: add repl --- .../@stdlib/lapack/base/dlasv2/docs/repl.txt | 98 +++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/docs/repl.txt diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/docs/repl.txt b/lib/node_modules/@stdlib/lapack/base/dlasv2/docs/repl.txt new file mode 100644 index 00000000000..522919449ed --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/docs/repl.txt @@ -0,0 +1,98 @@ + +{{alias}}( F, G, H, out ) + Computes singular value decomposition of a 2x2 triangular matrix. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + Parameters + ---------- + F: number + The (0,0) element of matrix. + + G: number + The (0,1) element of matrix. + + H: number + The (1,1) element of matrix. + + out: Float64Array + Output array containing `SSMIN`, `SSMAX`, `SNR`, `CSR`, `SNL`, and + `CSL` respectively. + + Returns + ------- + out: Float64Array + Mutated array. + + Examples + -------- + > var out = new {{alias:@stdlib/array/float64}}( 6 ); + > {{alias}}( 2.0, 3.0, 4.0, out ); + > out[ 0 ] + 1.5513263285176897 + > out[ 1 ] + 5.1568776039816795 + > out[ 2 ] + 0.9664996487646696 + > out[ 3 ] + 0.25666793515702424 + > out[ 4 ] + 0.7496781758158659 + > out[ 5 ] + 0.6618025632357402 + + +{{alias}}.ndarray( F, G, H, out, strideOut, offsetOut ) + Computes singular value decomposition of a 2x2 triangular matrix using + alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + F: number + The (0,0) element of matrix. + + G: number + The (0,1) element of matrix. + + H: number + The (1,1) element of matrix. + + out: Float64Array + Output array containing `SSMIN`, `SSMAX`, `SNR`, `CSR`, `SNL`, and + `CSL` respectively. + + strideOut: integer + Stride length for `Out`. + + offsetOut: integer + Starting index for `Out`. + + Returns + ------- + out: Float64Array + Mutated array. + + Examples + -------- + > var out = new {{alias:@stdlib/array/float64}}( 6 ); + > {{alias}}.ndarray( 2.0, 3.0, 4.0, out, 1, 0 ); + > out[ 0 ] + 1.5513263285176897 + > out[ 1 ] + 5.1568776039816795 + > out[ 2 ] + 0.9664996487646696 + > out[ 3 ] + 0.25666793515702424 + > out[ 4 ] + 0.7496781758158659 + > out[ 5 ] + 0.6618025632357402 + + See Also + -------- From 8bf7474071bedfc385043ec4fc8732037a52c122 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Thu, 22 Aug 2024 09:24:06 +0530 Subject: [PATCH 5/6] feat: add other files --- .../lapack/base/dlasv2/benchmark/benchmark.js | 92 ++++++++ .../dlasv2/benchmark/benchmark.ndarray.js | 92 ++++++++ .../lapack/base/dlasv2/docs/types/index.d.ts | 94 ++++++++ .../lapack/base/dlasv2/docs/types/test.ts | 200 ++++++++++++++++++ .../lapack/base/dlasv2/examples/index.js | 27 +++ .../@stdlib/lapack/base/dlasv2/lib/index.js | 64 ++++++ .../@stdlib/lapack/base/dlasv2/package.json | 72 +++++++ .../lapack/base/dlasv2/test/test.dlasv2.js | 135 ++++++++++++ .../@stdlib/lapack/base/dlasv2/test/test.js | 82 +++++++ .../lapack/base/dlasv2/test/test.ndarray.js | 92 ++++++++ 10 files changed, 950 insertions(+) create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/examples/index.js create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/lib/index.js create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/package.json create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.dlasv2.js create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.js create mode 100644 lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.ndarray.js diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/benchmark/benchmark.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/benchmark/benchmark.js new file mode 100644 index 00000000000..c8576c644c8 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/benchmark/benchmark.js @@ -0,0 +1,92 @@ +/** +* @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 uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pkg = require( './../package.json' ).name; +var dlasv2 = require( './../lib/dlasv2.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @returns {Function} benchmark function +*/ +function createBenchmark( ) { + var out = uniform( 6, 0.0, 100.0, options ); + return benchmark; + + function benchmark( b ) { + var d; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + d = dlasv2( out[ 0 ], out[ 2 ], out[ 1 ], out ); + if ( isnan( d[ i%out.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d[ i%out.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 f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + f = createBenchmark(); + bench( pkg, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/benchmark/benchmark.ndarray.js new file mode 100644 index 00000000000..86c149516c2 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/benchmark/benchmark.ndarray.js @@ -0,0 +1,92 @@ +/** +* @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 uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pkg = require( './../package.json' ).name; +var dlasv2 = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @returns {Function} benchmark function +*/ +function createBenchmark( ) { + var out = uniform( 6, 0.0, 100.0, options ); + return benchmark; + + function benchmark( b ) { + var d; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + d = dlasv2( out[ 0 ], out[ 2 ], out[ 1 ], out, 1, 0 ); + if ( isnan( d[ i%out.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d[ i%out.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 f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + f = createBenchmark(); + bench( pkg+':ndarray', f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/docs/types/index.d.ts b/lib/node_modules/@stdlib/lapack/base/dlasv2/docs/types/index.d.ts new file mode 100644 index 00000000000..04574728677 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/docs/types/index.d.ts @@ -0,0 +1,94 @@ +/** +* @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 + +/// + +/** +* Interface describing `dlasv2`. +*/ +interface Routine { + /** + * Computes singular value decomposition of a 2x2 triangular matrix. + * + * @param F - the (0,0) element of matrix + * @param G - the (0,1) element of matrix + * @param H - the (1,1) element of matrix + * @param out - output array containing `SSMIN`, `SSMAX`, `SNR`, `CSR`, `SNL`, and `CSL` respectively + * @returns output array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * var out = new Float64Array( 6 ); + * + * out = dlasv2( 2.0, 3.0, 4.0, out ); + * // out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] + */ + ( F: number, G: number, H: number, out: Float64Array ): Float64Array; + + /** + * Computes singular value decomposition of a 2x2 triangular matrix using alternative indexing semantics. + * + * @param F - the (0,0) element of matrix + * @param G - the (0,1) element of matrix + * @param H - the (1,1) element of matrix + * @param out - output array containing `SSMIN`, `SSMAX`, `SNR`, `CSR`, `SNL`, and `CSL` respectively + * @param strideOut - stride length for `out` + * @param offsetOut - starting index of `out` + * @returns output array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * var out = new Float64Array( 6 ); + * + * out = dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, 0 ); + * // out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] + */ + ndarray( F: number, G: number, H: number, out: Float64Array, strideOut: number, offsetOut: number ): Float64Array; +} + +/** +* Computes singular value decomposition of a 2x2 triangular matrix. +* +* @param F - the (0,0) element of matrix +* @param G - the (0,1) element of matrix +* @param H - the (1,1) element of matrix +* @param out - output array containing `SSMIN`, `SSMAX`, `SNR`, `CSR`, `SNL`, and `CSL` respectively +* @returns output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var out = new Float64Array( 6 ); +* +* out = dlasv2( 2.0, 3.0, 4.0, out ); +* // out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var out = new Float64Array( 6 ); +* +* out = dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, 0 ); +* // out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +*/ +declare var dlasv2: Routine; + + +// EXPORTS // + +export = dlasv2; diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/docs/types/test.ts b/lib/node_modules/@stdlib/lapack/base/dlasv2/docs/types/test.ts new file mode 100644 index 00000000000..fdc8f1c9828 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/docs/types/test.ts @@ -0,0 +1,200 @@ +/* +* @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 dlasv2 = require( './index' ); + + +// TESTS // + +// The function returns a Float64Array... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2( 2.0, 3.0, 4.0, out ); // $ExpectType Float64Array +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2( '5', 3.0, 4.0, out ); // $ExpectError + dlasv2( true, 3.0, 4.0, out ); // $ExpectError + dlasv2( false, 3.0, 4.0, out ); // $ExpectError + dlasv2( null, 3.0, 4.0, out ); // $ExpectError + dlasv2( void 0, 3.0, 4.0, out ); // $ExpectError + dlasv2( [], 3.0, 4.0, out ); // $ExpectError + dlasv2( {}, 3.0, 4.0, out ); // $ExpectError + dlasv2( ( x: number ): number => x, 3.0, 4.0, out ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2( 2.0, '5', 4.0, out ); // $ExpectError + dlasv2( 2.0, true, 4.0, out ); // $ExpectError + dlasv2( 2.0, false, 4.0, out ); // $ExpectError + dlasv2( 2.0, null, 4.0, out ); // $ExpectError + dlasv2( 2.0, void 0, 4.0, out ); // $ExpectError + dlasv2( 2.0, [], 4.0, out ); // $ExpectError + dlasv2( 2.0, {}, 4.0, out ); // $ExpectError + dlasv2( 2.0, ( x: number ): number => x, 4.0, out ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2( 2.0, 3.0, '5', out ); // $ExpectError + dlasv2( 2.0, 3.0, true, out ); // $ExpectError + dlasv2( 2.0, 3.0, false, out ); // $ExpectError + dlasv2( 2.0, 3.0, null, out ); // $ExpectError + dlasv2( 2.0, 3.0, void 0, out ); // $ExpectError + dlasv2( 2.0, 3.0, [], out ); // $ExpectError + dlasv2( 2.0, 3.0, {}, out ); // $ExpectError + dlasv2( 2.0, 3.0, ( x: number ): number => x, out ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Float64Array... +{ + + dlasv2( 2.0, 3.0, 4.0, '5' ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0, 5 ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0, true ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0, false ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0, null ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0, void 0 ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0, [] ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0, {} ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2(); // $ExpectError + dlasv2( 2.0 ); // $ExpectError + dlasv2( 2.0, 3.0 ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0 ); // $ExpectError + dlasv2( 2.0, 3.0, 4.0, out, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Float64Array... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, 0 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2.ndarray( '5', 3.0, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( true, 3.0, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( false, 3.0, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( null, 3.0, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( void 0, 3.0, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( [], 3.0, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( {}, 3.0, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( ( x: number ): number => x, 3.0, 4.0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2.ndarray( 2.0, '5', 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, true, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, false, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, null, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, void 0, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, [], 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, {}, 4.0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, ( x: number ): number => x, 4.0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2.ndarray( 2.0, 3.0, '5', out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, true, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, false, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, null, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, void 0, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, [], out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, {}, out, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, ( x: number ): number => x, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Float64Array... +{ + + dlasv2.ndarray( 2.0, 3.0, 4.0, '5', 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, 5, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, true, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, false, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, null, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, void 0, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, [], 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, {}, 1, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2.ndarray( 2.0, 3.0, 4.0, out, '5', 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, true, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, false, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, null, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, void 0, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, [], 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, {}, 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a sixth argument which is not a number... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, '5' ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, true ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, false ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, null ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, void 0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, [] ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, {} ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const out = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + + dlasv2.ndarray(); // $ExpectError + dlasv2.ndarray( 2.0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1 ); // $ExpectError + dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/examples/index.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/examples/index.js new file mode 100644 index 00000000000..c9b8029f0dd --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/examples/index.js @@ -0,0 +1,27 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var dlasv2 = require( './../lib/' ); + +var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + +out = dlasv2( 2.0, 3.0, 4.0, out ); +console.log( out ); diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/index.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/index.js new file mode 100644 index 00000000000..3dec6d39763 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/index.js @@ -0,0 +1,64 @@ +/** +* @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'; + +/** +* LAPACK routine to compute singular value decomposition of a 2x2 triangular matrix. +* +* @module @stdlib/lapack/base/dlasv2 +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dlasv2 = require( '@stdlib/lapack/base/dlasv2' ); +* var out = new Float64Array( 6 ); +* +* out = dlasv2( 2.0, 3.0, 4.0, out ); +* // out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dlasv2 = require( '@stdlib/lapack/base/dlasv2' ); +* var out = new Float64Array( 6 ); +* +* out = dlasv2.ndarray( 2.0, 3.0, 4.0, out, 1, 0 ); +* // out => [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] +*/ + +// 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 dlasv2; +var tmp = tryRequire( join( __dirname, './native.js' ) ); +if ( isError( tmp ) ) { + dlasv2 = main; +} else { + dlasv2 = tmp; +} + + +// EXPORTS // + +module.exports = dlasv2; diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/package.json b/lib/node_modules/@stdlib/lapack/base/dlasv2/package.json new file mode 100644 index 00000000000..2268df5c378 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/package.json @@ -0,0 +1,72 @@ +{ + "name": "@stdlib/lapack/base/dlaswp", + "version": "0.0.0", + "description": "Compute singular value decomposition of a 2x2 triangular matrix.", + "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", + "lapack", + "svd", + "decomposition", + "dlasv2", + "exchange", + "permute", + "permutedims", + "linear", + "algebra", + "subroutines", + "array", + "ndarray", + "float64", + "double", + "float64array" + ] +} diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.dlasv2.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.dlasv2.js new file mode 100644 index 00000000000..5c985596e01 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.dlasv2.js @@ -0,0 +1,135 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var dlasv2 = require( './../lib/dlasv2.js' ); + + +// 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 dlasv2, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 4', function test( t ) { + t.strictEqual( dlasv2.length, 4, 'returns expected value' ); + t.end(); +}); + +tape( 'the function correctly computes svd of triangular matrix with elements in increasing order', function test( t ) { + var expected; + var out; + + out = new Float64Array( 6 ); + expected = new Float64Array( [ 1.5513263285176897, 5.1568776039816795, 0.9664996487646696, 0.25666793515702424, 0.7496781758158659, 0.6618025632357402 ] ); + out = dlasv2( 2.0, 3.0, 4.0, out ); + isApprox( t, out, expected, 1.0 ); + + expected = new Float64Array( [ -0.9522030268983716, 9.871844275289476, 0.999516648263737, -0.031088098102407546, 0.9517427779120455, 0.3068968632818896 ] ); + out = dlasv2( -1.0, 3.0, 9.4, out ); + isApprox( t, out, expected, 1.0 ); + + expected = new Float64Array( [ -3.518670509963777, -120.37955779052484, 0.5581876810704361, 0.8297147176597564, 0.019660445769845943, 0.9998067147564729 ] ); + out = dlasv2( -99.9, -67.124, -4.24, out ); + isApprox( t, out, expected, 1.0 ); + t.end(); +}); + +tape( 'the function correctly computes svd of triangular matrix with elements in decreasing order', function test( t ) { + var expected; + var out; + + expected = new Float64Array( [ 1.5513263285176897, 5.1568776039816795, 0.6618025632357402, 0.7496781758158659, 0.25666793515702424, 0.9664996487646696 ] ); + out = new Float64Array( 6 ); + out = dlasv2( 4.0, 3.0, 2.0, out ); + isApprox( t, out, expected, 1.0 ); + + expected = new Float64Array( [ -0.9522030268983716, 9.871844275289476, 0.3068968632818896, 0.9517427779120455, -0.031088098102407546, 0.999516648263737 ] ); + out = dlasv2( 9.4, 3.0, -1.0, out ); + isApprox( t, out, expected, 1.0 ); + + expected = new Float64Array( [ -3.518670509963777, -120.37955779052484, 0.9998067147564729, 0.019660445769845943, 0.8297147176597564, 0.5581876810704361 ] ); + out = dlasv2( -4.24, -67.124, -99.9, out ); + isApprox( t, out, expected, 1.0 ); + t.end(); +}); + +tape( 'the function correcly computes svd of triangular matrix with parameter `G` greater than both', function test( t ) { + var expected; + var out; + + expected = new Float64Array( [ 1.2125424343860751, 6.597707241520579, 0.8090383403577232, 0.5877558709457702, 0.2452483296822559, 0.9694602914962858 ] ); + out = new Float64Array( 6 ); + out = dlasv2( 4.0, 5.0, 2.0, out ); + isApprox( t, out, expected, 1.0 ); + t.end(); +}); + +tape( 'the function correctly computes svd of diagonal matrix', function test( t ) { + var expected; + var out; + + expected = new Float64Array( [ 2.0, -12.0, 1.0, 0.0, 1.0, 0.0 ] ); + out = new Float64Array( 6 ); + out = dlasv2( 2.0, 0.0, -12.0, out ); + isApprox( t, out, expected, 1.0 ); + + expected = new Float64Array( [ 9.0, -122.0, 0.0, 1.0, 0.0, 1.0 ] ); + out = new Float64Array( 6 ); + out = dlasv2( -122.0, 0.0, 9.0, out ); + isApprox( t, out, expected, 1.0 ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.js new file mode 100644 index 00000000000..d9cb0e88954 --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/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 dlasv2 = 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 dlasv2, '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 dlasv2.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 dlasv2 = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dlasv2, 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 dlasv2; + var main; + + main = require( './../lib/dlasv2.js' ); + + dlasv2 = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dlasv2, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.ndarray.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.ndarray.js new file mode 100644 index 00000000000..c840b954eaa --- /dev/null +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/test/test.ndarray.js @@ -0,0 +1,92 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var dlasv2 = require( './../lib/ndarray.js' ); + + +// 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 dlasv2, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 6', function test( t ) { + t.strictEqual( dlasv2.length, 6, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access pattern to store computed values', function test( t ) { + var expected; + var out; + + expected = new Float64Array( [ 999.9, 1.2125424343860751, 999.9, 6.597707241520579, 999.9, 0.8090383403577232, 999.9, 0.5877558709457702, 999.9, 0.2452483296822559, 999.9, 0.9694602914962858 ] ); + out = new Float64Array( [ 999.9, 0.0, 999.9, 0.0, 999.9, 0.0, 999.9, 0.0, 999.9, 0.0, 999.9, 0.0 ] ); + out = dlasv2( 4.0, 5.0, 2.0, out, 2, 1 ); + isApprox( t, out, expected, 1.0 ); + t.end(); +}); + +tape( 'the function supports accessing elements in reverse order to store computed values', function test( t ) { + var expected; + var out; + + expected = new Float64Array( [ 999.9, 0.9694602914962858, 999.9, 0.2452483296822559, 999.9, 0.5877558709457702, 999.9, 0.8090383403577232, 999.9, 6.597707241520579, 999.9, 1.2125424343860751 ] ); + out = new Float64Array( [ 999.9, 0.0, 999.9, 0.0, 999.9, 0.0, 999.9, 0.0, 999.9, 0.0, 999.9, 0.0 ] ); + out = dlasv2( 4.0, 5.0, 2.0, out, -2, out.length-1 ); + isApprox( t, out, expected, 1.0 ); + t.end(); +}); From ec39c56389ce458f4a0358edd89beec5349dcd0a Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Thu, 22 Aug 2024 09:24:58 +0530 Subject: [PATCH 6/6] chore: add type notation in jsdoc of ndarray --- lib/node_modules/@stdlib/lapack/base/dlasv2/lib/ndarray.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/ndarray.js b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/ndarray.js index f0d34d7ec6a..8cc3686f201 100644 --- a/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/ndarray.js +++ b/lib/node_modules/@stdlib/lapack/base/dlasv2/lib/ndarray.js @@ -28,6 +28,7 @@ var base = require( './base.js' ); /** * Computes singular value decomposition of a 2x2 triangular matrix using alternative indexing semantics. * +* @type {Function} * @param {number} F - the (0,0) element of matrix * @param {number} G - the (0,1) element of matrix * @param {number} H - the (1,1) element of matrix