From aacd5663a0282b258e78d60155147c3c4e068e88 Mon Sep 17 00:00:00 2001 From: Vinit Pandit Date: Tue, 14 Jan 2025 10:34:34 +0000 Subject: [PATCH 01/12] feat: add javascript implementation of blas/base/cdotc --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/blas/base/cdotc/README.md | 232 ++++++++++++++++ .../blas/base/cdotc/benchmark/benchmark.js | 110 ++++++++ .../base/cdotc/benchmark/benchmark.ndarray.js | 110 ++++++++ .../@stdlib/blas/base/cdotc/docs/repl.txt | 122 +++++++++ .../blas/base/cdotc/docs/types/index.d.ts | 107 ++++++++ .../blas/base/cdotc/docs/types/test.ts | 249 ++++++++++++++++++ .../@stdlib/blas/base/cdotc/examples/index.js | 38 +++ .../@stdlib/blas/base/cdotc/lib/cdotc.js | 72 +++++ .../@stdlib/blas/base/cdotc/lib/index.js | 87 ++++++ .../@stdlib/blas/base/cdotc/lib/main.js | 35 +++ .../@stdlib/blas/base/cdotc/lib/ndarray.js | 86 ++++++ .../@stdlib/blas/base/cdotc/package.json | 83 ++++++ .../blas/base/cdotc/test/test.cdotc.js | 215 +++++++++++++++ .../@stdlib/blas/base/cdotc/test/test.js | 82 ++++++ .../blas/base/cdotc/test/test.ndarray.js | 215 +++++++++++++++ 15 files changed, 1843 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/README.md b/lib/node_modules/@stdlib/blas/base/cdotc/README.md new file mode 100644 index 000000000000..ae7ee0a69880 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/README.md @@ -0,0 +1,232 @@ + + +# cdotc + +> Calculate the dot product of two single-precision complex vectors. + +
+ +The [dot product][dot-product] (or scalar product) is defined as + +
+ + + +
+ +## Usage + +```javascript +var cdotc = require( '@stdlib/blas/base/cdotc' ); +``` + +#### cdotc( N, x, strideX, y, strideY ) + +Calculates the dot product of complex vectors `x` and `y`. + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + +var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); +var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); + +var out = cdotc( x.length, x, 1, y, 1 ); +// returns + +var re = realf( out ); +// returns 54 + +var im = imagf( out ); +// returns -80 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Complex64Array`][@stdlib/array/complex64]. +- **strideX**: index increment for `x`. +- **y**: input [`Complex64Array`][@stdlib/array/complex64]. +- **strideY**: index increment for `y`. + +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to calculate the dot product of every other value in `x` and the first `N` elements of `y` in reverse order, + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + +var x = new Complex64Array( [ -1.0, -9.0, 2.0, -8.0 ] ); +var y = new Complex64Array( [ -5.0, 1.0, -6.0, 7.0 ] ); + +var out = cdotc( x.length, x, 1, y, -1 ); +// returns + +var re = realf( out ); +// returns -75 + +var im = imagf( out ); +// returns -99 +``` + +#### cdotc.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + +Calculates the dot product of `x` and `y` using alternative indexing semantics. + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + +var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); +var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); + +var out = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); +// returns + +var re = realf( out ); +// returns 54 + +var im = imagf( out ); +// returns -80 +``` + +The function has the following additional parameters: + +- **offsetX**: starting index for `x`. +- **offsetY**: starting index for `y`. + +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, to calculate the dot product of every other value in `x` starting from the second value with the last 2 elements in `y` in reverse order + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + +var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); +var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); + +var out = cdotc.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); +// returns + +var re = realf( out ); +// returns -55 + +var im = imagf( out ); +// returns 23 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return complex64 with real and imagnary as `0.0`. +- `cdotc()` corresponds to the [BLAS][blas] level 1 function [`cdotc`][cdotc]. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); + +function rand() { + return new Complex64( discreteUniform( 0, 10 ), discreteUniform( 1, 5 ) ); +} + +var cx = filledarrayBy( 10, 'complex64', rand ); +console.log( cx.toString() ); + +var cy = filledarrayBy( 10, 'complex64', rand ); +console.log( cy.toString() ); + +// Perform dot product of cx and cy +var out = cdotc.ndarray( cx.length, cx, 1, 0, cy, -1, cy.length-1 ); +console.log( out ); +``` + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/blas/base/zdotc`][@stdlib/blas/base/zdotc]: calculate the dot product of two double-precision complex vectors. +- [`@stdlib/blas/base/cdotu`][@stdlib/blas/base/cdotu]: calculate the dot product without conjugate of x of two single-precision complex vectors. +- [`@stdlib/blas/base/zdotu`][@stdlib/blas/base/zdotu]: calculate the dot product without conjugate of x of two double-precision complex vectors. +- [`@stdlib/blas/cdotc`][@stdlib/blas/cdotc]: calculate the dot product of two single-precision comple vectors. + +
+ + + + + +
+ +[dot-product]: https://en.wikipedia.org/wiki/Dot_product + +[blas]: http://www.netlib.org/blas + +[cdotc]: http://www.netlib.org/lapack/explore-html/df/d28/group__single__blas__level1.html + +[@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64 + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + + + +[@stdlib/blas/base/zdotc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/zdotc + +[@stdlib/blas/base/cdotu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/cdotu + +[@stdlib/blas/base/zdotu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/zdotu + +[@stdlib/blas/cdotc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/cdotc + + + +
+ + diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js new file mode 100644 index 000000000000..ee925781620f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js @@ -0,0 +1,110 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 pow = require( '@stdlib/math/base/special/pow' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); +var pkg = require( './../package.json' ).name; +var cdotc = require( './../lib/cdotc.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var cx; + var cy; + + cx = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + cy = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = cdotc( cx.length, cx, 1, cy, 1 ); + if ( isnanf( realf( out ) ) || isnanf( imagf( out ) )) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( realf( out ) ) || isnanf( imagf( out ) )) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..9a61f62f32a7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js @@ -0,0 +1,110 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 pow = require( '@stdlib/math/base/special/pow' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); +var pkg = require( './../package.json' ).name; +var cdotc = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var cx; + var cy; + + cx = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + cy = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = cdotc( cx.length, cx, 1, 0, cy, 1, 0 ); + if ( isnanf( realf( out ) ) || isnanf( imagf( out ) )) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( realf( out ) ) || isnanf( imagf( out ) )) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt new file mode 100644 index 000000000000..977e2e46af90 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt @@ -0,0 +1,122 @@ + +{{alias}}( N, x, strideX, y, strideY ) + Computes the dot product of two single-precision complex vectors. + + The `N` and stride parameters determine which elements in the strided arrays + are accessed at runtime. + + Indexing is relative to the first index. To introduce an offset, use a typed + array view. + + If `N <= 0`, the function returns `0`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Complex64Array + First input array. + + strideX: integer + Index increment for `x`. + + y: Complex64Array + Second input array. + + strideY: integer + Index increment for `y`. + + Returns + ------- + out: Complex64 + The dot product. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -1.0, -9.0 ] ); + > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0 ] ); + > var out = {{alias}}( x.length, x, 1, y, 1 ); + > var re = {{alias:@stdlib/complex/float32/real}}( out ) + 54 + > var im = {{alias:@stdlib/complex/float32/imag}}( out ) + -80 + + // Strides: + > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); + > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); + > out = {{alias}}( 2, x, 2, y, 1 ); + > var re = {{alias:@stdlib/complex/float32/real}}( out ) + 54 + > var im = {{alias:@stdlib/complex/float32/imag}}( out ) + -80 + + +{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + Computes the dot product of two single-precision complex vectors + using alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing based on a starting index. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Complex64Array + First input array. + + strideX: integer + Index increment for `x`. + + offsetX: integer + Starting index for `x`. + + y: Complex64Array + Second input array. + + strideY: integer + Index increment for `y`. + + offsetY: integer + Starting index for `y`. + + Returns + ------- + out: Complex64 + The dot product. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -1.0, -9.0 ] ); + > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0 ] ); + > var out = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ); + > var re = {{alias:@stdlib/complex/float32/real}}( out ) + 54 + > var im = {{alias:@stdlib/complex/float32/imag}}( out ) + -80 + + // Strides: + > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); + > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); + > out = {{alias}}.ndarray( 2, x, 2, 0, y, 1, 0 ); + > var re = {{alias:@stdlib/complex/float32/real}}( out ) + 54 + > var im = {{alias:@stdlib/complex/float32/imag}}( out ) + -80 + + // Using offset indices: + > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); + > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); + > out = {{alias}}.ndarray( 2, x, -2, x.length-1, y, 1, 1 ); + > var re = {{alias:@stdlib/complex/float32/real}}( out ) + 61 + > var im = {{alias:@stdlib/complex/float32/imag}}( out ) + -72 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/index.d.ts new file mode 100644 index 000000000000..949080bec76a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/index.d.ts @@ -0,0 +1,107 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import { Complex64 } from '@stdlib/types/complex'; +import { Complex64Array } from '@stdlib/types/array'; + + +// TypeScript Version: 4.1 + +/** +* Interface describing `cdotc`. +*/ +interface Routine { + /** + * Computes the dot product of two single-precision complex vectors. + * + * @param N - number of indexed elements + * @param x - first input complex array + * @param strideX - `x` stride length + * @param y - second input complex array + * @param strideY - `y` stride length + * @returns dot product + * + * @example + * var Complex64Array = require( '@stdlib/array/complex64' ); + * + * var x = new Complex64Array( [ 7, -8, -1, -9 ] ); + * var y = new Complex64Array( [ 6, -6, -9, 5 ] ); + * + * var z = cdotc( x.length, x, 1, y, 1 ); + * // returns + */ + ( N: number, x: Complex64Array, strideX: number, y: Complex64Array, strideY: number ): Complex64; + + /** + * Computes the dot product of `x` and `y` using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param y - second input array + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @returns dot product + * + * @example + * var Complex64Array = require( '@stdlib/array/complex64' ); + * + * var x = new Complex64Array( [ 7, -8, -1, -9 ] ); + * var y = new Complex64Array( [ 6, -6, -9, 5 ] ); + * + * var z = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * // returns + */ + ndarray( N: number, x: Complex64Array, strideX: number, offsetX: number, y: Complex64Array, strideY: number, offsetY: number ): Complex64; +} + +/** +* Computes the dot product of `x` and `y`. +* +* @param N - number of indexed elements +* @param x - first input array +* @param strideX - `x` stride length +* @param y - second input array +* @param strideY - `y` stride length +* @returns dot product +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* +* var x = new Complex64Array( [ 7, -8, -1, -9 ] ); +* var y = new Complex64Array( [ 6, -6, -9, 5 ] ); +* +* var z = cdotc( x.length, x, 1, y, 1 ); +* // returns +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* +* var x = new Complex64Array( [ 7, -8, -1, -9 ] ); +* var y = new Complex64Array( [ 6, -6, -9, 5 ] ); +* +* var z = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns +*/ +declare var cdotc: Routine; + + +// EXPORTS // + +export = cdotc; diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/test.ts new file mode 100644 index 000000000000..15d22a09fb7d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/test.ts @@ -0,0 +1,249 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2020 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 Complex64Array = require( '@stdlib/array/complex64' ); +import cdotc = require( './index' ); + + +// TESTS // + +// The function returns a Complex64... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc( x.length, x, 1, y, 1 ); // $ExpectType Complex64 +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc( '10', x, 1, y, 1 ); // $ExpectError + cdotc( true, x, 1, y, 1 ); // $ExpectError + cdotc( false, x, 1, y, 1 ); // $ExpectError + cdotc( null, x, 1, y, 1 ); // $ExpectError + cdotc( undefined, x, 1, y, 1 ); // $ExpectError + cdotc( [], x, 1, y, 1 ); // $ExpectError + cdotc( {}, x, 1, y, 1 ); // $ExpectError + cdotc( ( x: number ): number => x, x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a Complex64Array.. +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc( x.length, 10, 1, y, 1 ); // $ExpectError + cdotc( x.length, '10', 1, y, 1 ); // $ExpectError + cdotc( x.length, true, 1, y, 1 ); // $ExpectError + cdotc( x.length, false, 1, y, 1 ); // $ExpectError + cdotc( x.length, null, 1, y, 1 ); // $ExpectError + cdotc( x.length, undefined, 1, y, 1 ); // $ExpectError + cdotc( x.length, [], 1, y, 1 ); // $ExpectError + cdotc( x.length, {}, 1, y, 1 ); // $ExpectError + cdotc( x.length, ( x: number ): number => x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc( x.length, x, '10', y, 1 ); // $ExpectError + cdotc( x.length, x, true, y, 1 ); // $ExpectError + cdotc( x.length, x, false, y, 1 ); // $ExpectError + cdotc( x.length, x, null, y, 1 ); // $ExpectError + cdotc( x.length, x, undefined, y, 1 ); // $ExpectError + cdotc( x.length, x, [], y, 1 ); // $ExpectError + cdotc( x.length, x, {}, y, 1 ); // $ExpectError + cdotc( x.length, x, ( x: number ): number => x, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Complex64Array... +{ + const x = new Complex64Array( 10 ); + + cdotc( x.length, x, 1, 10, 1 ); // $ExpectError + cdotc( x.length, x, 1, '10', 1 ); // $ExpectError + cdotc( x.length, x, 1, true, 1 ); // $ExpectError + cdotc( x.length, x, 1, false, 1 ); // $ExpectError + cdotc( x.length, x, 1, null, 1 ); // $ExpectError + cdotc( x.length, x, 1, undefined, 1 ); // $ExpectError + cdotc( x.length, x, 1, [], 1 ); // $ExpectError + cdotc( x.length, x, 1, {}, 1 ); // $ExpectError + cdotc( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc( x.length, x, 1, y, '10' ); // $ExpectError + cdotc( x.length, x, 1, y, true ); // $ExpectError + cdotc( x.length, x, 1, y, false ); // $ExpectError + cdotc( x.length, x, 1, y, null ); // $ExpectError + cdotc( x.length, x, 1, y, undefined ); // $ExpectError + cdotc( x.length, x, 1, y, [] ); // $ExpectError + cdotc( x.length, x, 1, y, {} ); // $ExpectError + cdotc( x.length, x, 1, y, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc(); // $ExpectError + cdotc( x.length ); // $ExpectError + cdotc( x.length, x ); // $ExpectError + cdotc( x.length, x, 1 ); // $ExpectError + cdotc( x.length, x, 1, y ); // $ExpectError + cdotc( x.length, x, 1, y, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Complex64... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType Complex64 +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( ( x: number ): number => x, x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Complex64Array... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, [], 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, ( x: number ): number => x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, ( x: number ): number => x, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a Complex64Array... +{ + const x = new Complex64Array( 10 ); + + cdotc.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, [], 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, 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 Complex64Array( 10 ); + const y = new Complex64Array( 10 ); + + cdotc.ndarray(); // $ExpectError + cdotc.ndarray( x.length ); // $ExpectError + cdotc.ndarray( x.length, x ); // $ExpectError + cdotc.ndarray( x.length, x, 1 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError + cdotc.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js b/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js new file mode 100644 index 000000000000..b49249750b74 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js @@ -0,0 +1,38 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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/base/discrete-uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var cdotc = require( './../lib' ); + +function rand() { + return new Complex64( discreteUniform( 0, 10 ), discreteUniform( 1, 5 ) ); +} + +var cx = filledarrayBy( 10, 'complex64', rand ); +console.log( cx.toString() ); + +var cy = filledarrayBy( 10, 'complex64', rand ); +console.log( cy.toString() ); + +// Perform dot product of cx and cy +var out = cdotc.ndarray( cx.length, cx, 1, 0, cy, -1, cy.length-1 ); +console.log( out ); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js new file mode 100644 index 000000000000..90610ee5852b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js @@ -0,0 +1,72 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +/** +* Computes the dot product of `x` and `y`. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {Complex64Array} x - first input array +* @param {integer} strideX - `x` stride length +* @param {Complex64Array} y - second input array +* @param {integer} strideY - `y` stride length +* @returns {Complex64} dot product +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* +* var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); +* var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); +* +* var out = cdotc( x.length, x, 1, y, 1 ); +* // returns +* +* var re = realf( out ); +* // returns 54 +* +* var im = imagf( out ); +* // returns -80 +*/ +function cdotc( N, x, strideX, y, strideY ) { + var ix; + var iy; + if ( N <= 0 ) { + return new Complex64( 0, 0 ); + } + ix = stride2offset( N, strideX ); + iy = stride2offset( N, strideY ); + return ndarray( N, x, strideX, ix, y, strideY, iy ); +} + + +// EXPORTS // + +module.exports = cdotc; diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js new file mode 100644 index 000000000000..b9b3df1b7019 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js @@ -0,0 +1,87 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2019 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 1 routine to compute the dot product of two single-precision complex vectors. +* +* @module @stdlib/blas/base/cdotc +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* var cdotc = require( '@stdlib/blas/base/cdotc' ); +* +* var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); +* var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); +* var out = cdotc( x.length, x, 1, y, 1 ); +* // returns +* +* var re = realf( out ); +* // returns 54 +* +* var im = imagf( out ); +* // returns -80 +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* var cdotc = require( '@stdlib/blas/base/cdotc' ); +* +* var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); +* var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); +* +* var out = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns +* +* var re = realf( out ); +* // returns 54 +* +* var im = imagf( out ); +* // returns -80 +*/ + +// 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 cdotc; +var tmp = tryRequire( join( __dirname, './native.js' ) ); +if ( isError( tmp ) ) { + cdotc = main; +} else { + cdotc = tmp; +} + + +// EXPORTS // + +module.exports = cdotc; + +// exports: { "ndarray": "sdot.ndarray" } diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/main.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/main.js new file mode 100644 index 000000000000..d14c235cb5f3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/main.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2019 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 cdotc = require( './cdotc.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( cdotc, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = cdotc; diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js new file mode 100644 index 000000000000..f61569bdb65d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js @@ -0,0 +1,86 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 cmul = require( '@stdlib/complex/float32/base/mul' ); +var cadd = require( '@stdlib/complex/float32/base/add' ); +var conj = require( '@stdlib/complex/float32/conj' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); + + +// MAIN // + +/** +* Computes the dot product of `x` and `y`. +* +* @param {integer} N - number of indexed elements +* @param {Complex64Array} x - first input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @param {Complex64Array} y - second input array +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting index for `y` +* @returns {Complex64} dot product +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* +* var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); +* var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); +* +* var out = cdotc( x.length, x, 1, 0, y, 1, 0 ); +* // returns +* +* var re = realf( out ); +* // returns 54 +* +* var im = imagf( out ); +* // returns -80 +*/ +function cdotc( N, x, strideX, offsetX, y, strideY, offsetY ) { + var conjX; + var dot; + var ix; + var iy; + var i; + + dot = new Complex64( 0, 0 ); + if ( N <= 0 ) { + return dot; + } + ix = offsetX; + iy = offsetY; + for ( i = 0; i < N; i++ ) { + conjX = conj( x.get( ix ) ); + dot = cadd( dot, cmul( conjX, y.get( iy ) ) ); + ix += strideX; + iy += strideY; + } + return dot; +} + + +// EXPORTS // + +module.exports = cdotc; diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/package.json b/lib/node_modules/@stdlib/blas/base/cdotc/package.json new file mode 100644 index 000000000000..782b3cfc6a21 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/package.json @@ -0,0 +1,83 @@ +{ + "name": "@stdlib/blas/base/cdotc", + "version": "0.0.0", + "description": "Calculate the dot product of two single-precision complex vectors.", + "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", + "browser": "./lib/main.js", + "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 1", + "cdotc", + "dot", + "product", + "dot product", + "scalar", + "scalar product", + "inner", + "inner product", + "linear", + "algebra", + "subroutines", + "vector", + "array", + "ndarray", + "complex", + "complex64", + "float32", + "float", + "single", + "float32array" + ], + "__stdlib__": { + "wasm": false + } +} diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js new file mode 100644 index 000000000000..a05367bcd719 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js @@ -0,0 +1,215 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2019 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 Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var cdotc = require( './../lib/cdotc.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.deepEqual( typeof cdotc, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', function test( t ) { + t.deepEqual( cdotc.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the dot product of vectors `x` and `y`', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array( [ + 0.7, // 0 + -0.8, // 0 + -0.4, // 1 + -0.7 // 1 + ] ); + y = new Complex64Array( [ + 0.6, // 0 + -0.6, // 0 + -0.9, // 1 + 0.5 // 1 + ] ); + expected = new Complex64( 0.91, -0.77 ); + + dot = cdotc( x.length, x, 1, y, 1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns Complex( 0.0, 0.0 )', function test( t ) { + var expected; + var dot; + var x; + var y; + + expected = new Complex64( 0.0, 0.0 ); + x = new Complex64Array( [-0.1, -0.9, 0.2, -0.8 ] ); + y = new Complex64Array( [ 0.7, -0.6, 0.1, -0.5 ] ); + + dot = cdotc( 0, x, 1, y, 1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + + dot = cdotc( -4, x, 1, y, 1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, + -7, + -1, // 1 + -9, // 1 + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 0 + -6, // 0 + -9, // 1 + 5, // 1 + 7, + -6, + 1, + -5 + ]); + expected = new Complex64( 54, -80 ); + dot = cdotc( 2, x, 2, y, 1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, + -7, + -1, // 1 + -9, // 1 + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 1 + -6, // 1 + -9, // 0 + 5, // 0 + 7, + -6, + 1, + -5 + ]); + expected = new Complex64( -55, 23 ); + + dot = cdotc( 2, x, 2, y, -1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `y` stride', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, // 1 + -7, // 1 + -1, + -9, + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 0 + -6, // 0 + -9, + 5, + 7, // 1 + -6, // 1 + 1, + -5 + ]); + expected = new Complex64( 104, 79 ); + + dot = cdotc( 2, x, 1, y, 2 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 1 + -8, // 1 + -4, // 0 + -7, // 0 + -1, + -9, + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 1 + -6, // 1 + -9, + 5, + 7, // 0 + -6, // 0 + 1, + -5 + ]); + expected = new Complex64( 104, 79 ); + + dot = cdotc( 2, x, -1, y, -2 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.js new file mode 100644 index 000000000000..4475219c985e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2019 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 cdotc = 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 cdotc, '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 cdotc.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 cdotc = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( cdotc, 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 cdotc; + var main; + + main = require( './../lib/cdotc.js' ); + + cdotc = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( cdotc, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js new file mode 100644 index 000000000000..3e9b390bddf3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js @@ -0,0 +1,215 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2019 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 Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var cdotc = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.deepEqual( typeof cdotc, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', function test( t ) { + t.deepEqual( cdotc.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the dot product of complex vectors `x` and `y`', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array( [ + 0.7, // 0 + -0.8, // 0 + -0.4, // 1 + -0.7 // 1 + ] ); + y = new Complex64Array( [ + 0.6, // 0 + -0.6, // 0 + -0.9, // 1 + 0.5 // 1 + ] ); + expected = new Complex64( 0.91, -0.77 ); + + dot = cdotc( x.length, x, 1, 0, y, 1, 0 ); + t.deepEqual( dot, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns Complex( 0.0, 0.0 )', function test( t ) { + var expected; + var dot; + var x; + var y; + + expected = new Complex64( 0.0, 0.0 ); + x = new Complex64Array( [ -0.1, -0.9, 0.2, -0.8 ] ); + y = new Complex64Array( [ 0.7, -0.6, 0.1, -0.5 ] ); + + dot = cdotc( 0, x, 1, 0, y, 1, 0 ); + t.deepEqual( dot, expected, 'returns expected value' ); + + dot = cdotc( -4, x, 1, y, 1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, + -7, + -1, // 1 + -9, // 1 + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 0 + -6, // 0 + -9, // 1 + 5, // 1 + 7, + -6, + 1, + -5 + ]); + expected = new Complex64( 54, -80 ); + dot = cdotc( 2, x, 2, 0, y, 1, 0 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, + -7, + -1, // 1 + -9, // 1 + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 1 + -6, // 1 + -9, // 0 + 5, // 0 + 7, + -6, + 1, + -5 + ]); + expected = new Complex64( -55, 23 ); + + dot = cdotc( 2, x, 2, 0, y, -1, 1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `y` stride', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, // 1 + -7, // 1 + -1, + -9, + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 0 + -6, // 0 + -9, + 5, + 7, // 1 + -6, // 1 + 1, + -5 + ]); + expected = new Complex64( 104, 79 ); + + dot = cdotc( 2, x, 1, 0, y, 2, 0 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 1 + -8, // 1 + -4, // 0 + -7, // 0 + -1, + -9, + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 1 + -6, // 1 + -9, + 5, + 7, // 0 + -6, // 0 + 1, + -5 + ]); + expected = new Complex64( 104, 79 ); + + dot = cdotc( 2, x, -1, 1, y, -2, 2 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); From 556f4f5dccbd93849d50e07dc4bab0da4cf26572 Mon Sep 17 00:00:00 2001 From: Vinit Pandit Date: Tue, 14 Jan 2025 14:09:16 +0000 Subject: [PATCH 02/12] fix: fixing markdown example --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/blas/base/cdotc/README.md | 3 +++ lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js | 1 + 2 files changed, 4 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/README.md b/lib/node_modules/@stdlib/blas/base/cdotc/README.md index ae7ee0a69880..1d1ace828400 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/README.md +++ b/lib/node_modules/@stdlib/blas/base/cdotc/README.md @@ -47,6 +47,7 @@ var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); var realf = require( '@stdlib/complex/float32/real' ); var imagf = require( '@stdlib/complex/float32/imag' ); +var cdotc = require( '@stdlib/blas/base/cdotc' ); var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); @@ -99,6 +100,7 @@ var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); var realf = require( '@stdlib/complex/float32/real' ); var imagf = require( '@stdlib/complex/float32/imag' ); +var cdotc = require( '@stdlib/blas/base/cdotc' ); var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); @@ -125,6 +127,7 @@ var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); var realf = require( '@stdlib/complex/float32/real' ); var imagf = require( '@stdlib/complex/float32/imag' ); +var cdotc = require( '@stdlib/blas/base/cdotc' ); var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js index 90610ee5852b..5acc6dcb0a2c 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js @@ -42,6 +42,7 @@ var ndarray = require( './ndarray.js' ); * var Complex64 = require( '@stdlib/complex/float32/ctor' ); * var realf = require( '@stdlib/complex/float32/real' ); * var imagf = require( '@stdlib/complex/float32/imag' ); +* var cdotc = require( '@stdlib/blas/base/cdotc' ); * * var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); * var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); From 498ea050c5eee724b9b1f7763ab4d34ce6cd45b4 Mon Sep 17 00:00:00 2001 From: Vinit Pandit Date: Tue, 14 Jan 2025 14:20:04 +0000 Subject: [PATCH 03/12] fix: style fix --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: failed --- --- .../@stdlib/blas/base/cdotc/test/test.cdotc.js | 10 +++++----- .../@stdlib/blas/base/cdotc/test/test.ndarray.js | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js index a05367bcd719..6aa2cad026d8 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js @@ -45,18 +45,18 @@ tape( 'the function calculates the dot product of vectors `x` and `y`', function var x; var y; - x = new Complex64Array( [ + x = new Complex64Array([ 0.7, // 0 -0.8, // 0 -0.4, // 1 -0.7 // 1 - ] ); - y = new Complex64Array( [ + ]); + y = new Complex64Array([ 0.6, // 0 -0.6, // 0 -0.9, // 1 0.5 // 1 - ] ); + ]); expected = new Complex64( 0.91, -0.77 ); dot = cdotc( x.length, x, 1, y, 1 ); @@ -154,7 +154,7 @@ tape( 'the function supports an `y` stride', function test( t ) { var x; var y; - x = new Complex64Array([ + x = new Complex64Array( [ 7, // 0 -8, // 0 -4, // 1 diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js index 3e9b390bddf3..9b37e2836027 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js @@ -45,18 +45,18 @@ tape( 'the function calculates the dot product of complex vectors `x` and `y`', var x; var y; - x = new Complex64Array( [ + x = new Complex64Array([ 0.7, // 0 -0.8, // 0 -0.4, // 1 -0.7 // 1 - ] ); - y = new Complex64Array( [ + ]); + y = new Complex64Array([ 0.6, // 0 -0.6, // 0 -0.9, // 1 0.5 // 1 - ] ); + ]); expected = new Complex64( 0.91, -0.77 ); dot = cdotc( x.length, x, 1, 0, y, 1, 0 ); From 340f4df2f0301e4b92c57347dcaf5eafe87d3488 Mon Sep 17 00:00:00 2001 From: Vinit Pandit Date: Tue, 14 Jan 2025 14:28:04 +0000 Subject: [PATCH 04/12] fix: fixing style --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed --- --- lib/node_modules/@stdlib/blas/base/cdotc/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/README.md b/lib/node_modules/@stdlib/blas/base/cdotc/README.md index 1d1ace828400..c6d304d424dc 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/README.md +++ b/lib/node_modules/@stdlib/blas/base/cdotc/README.md @@ -47,7 +47,6 @@ var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); var realf = require( '@stdlib/complex/float32/real' ); var imagf = require( '@stdlib/complex/float32/imag' ); -var cdotc = require( '@stdlib/blas/base/cdotc' ); var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); @@ -100,7 +99,6 @@ var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); var realf = require( '@stdlib/complex/float32/real' ); var imagf = require( '@stdlib/complex/float32/imag' ); -var cdotc = require( '@stdlib/blas/base/cdotc' ); var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); @@ -127,7 +125,6 @@ var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); var realf = require( '@stdlib/complex/float32/real' ); var imagf = require( '@stdlib/complex/float32/imag' ); -var cdotc = require( '@stdlib/blas/base/cdotc' ); var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); @@ -167,6 +164,7 @@ var im = imagf( out ); var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); var filledarrayBy = require( '@stdlib/array/filled-by' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var cdotc = require( '@stdlib/blas/base/cdotc' ); function rand() { return new Complex64( discreteUniform( 0, 10 ), discreteUniform( 1, 5 ) ); From 1003bd7fee515b283b4b7568d4eb3997da98fa36 Mon Sep 17 00:00:00 2001 From: Vinit Pandit Date: Tue, 14 Jan 2025 14:30:55 +0000 Subject: [PATCH 05/12] fix: fixing spaces --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed --- --- lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js index 6aa2cad026d8..6212ea5cada5 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js @@ -154,7 +154,7 @@ tape( 'the function supports an `y` stride', function test( t ) { var x; var y; - x = new Complex64Array( [ + x = new Complex64Array([ 7, // 0 -8, // 0 -4, // 1 From ff192a2db104d209db463c2df8818d31061d0496 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:32:13 +0000 Subject: [PATCH 06/12] chore: update copyright years --- lib/node_modules/@stdlib/blas/base/cdotc/README.md | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js | 2 +- .../@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/docs/types/test.ts | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/lib/main.js | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/test/test.js | 2 +- lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/README.md b/lib/node_modules/@stdlib/blas/base/cdotc/README.md index c6d304d424dc..80ba8bccceb7 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/README.md +++ b/lib/node_modules/@stdlib/blas/base/cdotc/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2023 The Stdlib Authors. +Copyright (c) 2025 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js index ee925781620f..76aed09d1699 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2023 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js index 9a61f62f32a7..04b506e3bd19 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2023 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/test.ts index 15d22a09fb7d..62bcc7daa6b0 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2020 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js b/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js index b49249750b74..4beccfc55d72 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2023 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js index 5acc6dcb0a2c..0d7cb535ec27 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2023 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js index b9b3df1b7019..7edda9aeb5f6 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/main.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/main.js index d14c235cb5f3..da0894150706 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js index f61569bdb65d..084fa0e243c0 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2023 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js index 6212ea5cada5..b036aa60b7cd 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.js index 4475219c985e..3d88e15dccb8 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js index 9b37e2836027..a333a7f60c40 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From 2a06c82f170a8c5d3298194426ac47b5ea7a621f Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Fri, 13 Jun 2025 12:59:46 +0530 Subject: [PATCH 07/12] chore: update implementation --- .../@stdlib/blas/base/cdotc/README.md | 77 ++-------- .../blas/base/cdotc/benchmark/benchmark.js | 15 +- .../base/cdotc/benchmark/benchmark.ndarray.js | 15 +- .../@stdlib/blas/base/cdotc/docs/repl.txt | 39 ++--- .../blas/base/cdotc/docs/types/index.d.ts | 18 +-- .../@stdlib/blas/base/cdotc/examples/index.js | 17 ++- .../@stdlib/blas/base/cdotc/lib/cdotc.js | 19 +-- .../@stdlib/blas/base/cdotc/lib/index.js | 26 +--- .../@stdlib/blas/base/cdotc/lib/ndarray.js | 20 +-- .../blas/base/cdotc/test/test.cdotc.js | 89 +++++++++-- .../blas/base/cdotc/test/test.ndarray.js | 143 ++++++++++++++++-- 11 files changed, 282 insertions(+), 196 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/README.md b/lib/node_modules/@stdlib/blas/base/cdotc/README.md index 80ba8bccceb7..9229c223fd18 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/README.md +++ b/lib/node_modules/@stdlib/blas/base/cdotc/README.md @@ -20,7 +20,7 @@ limitations under the License. # cdotc -> Calculate the dot product of two single-precision complex vectors. +> Calculate the dot product `x^H * y` of `x` and `y`.
@@ -40,25 +40,17 @@ var cdotc = require( '@stdlib/blas/base/cdotc' ); #### cdotc( N, x, strideX, y, strideY ) -Calculates the dot product of complex vectors `x` and `y`. +Calculates the dot product `x^H * y` of `x` and `y`. ```javascript var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); var out = cdotc( x.length, x, 1, y, 1 ); -// returns - -var re = realf( out ); -// returns 54 - -var im = imagf( out ); -// returns -80 +// returns [ 54.0, -80.0 ] ``` The function has the following parameters: @@ -74,43 +66,27 @@ The `N` and stride parameters determine which elements in the strided arrays are ```javascript var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var x = new Complex64Array( [ -1.0, -9.0, 2.0, -8.0 ] ); var y = new Complex64Array( [ -5.0, 1.0, -6.0, 7.0 ] ); var out = cdotc( x.length, x, 1, y, -1 ); -// returns - -var re = realf( out ); -// returns -75 - -var im = imagf( out ); -// returns -99 +// returns [ -75.0, -99.0 ] ``` #### cdotc.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) -Calculates the dot product of `x` and `y` using alternative indexing semantics. +Calculates the dot product `x^H * y` of `x` and `y` using alternative indexing semantics. ```javascript var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); var out = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); -// returns - -var re = realf( out ); -// returns 54 - -var im = imagf( out ); -// returns -80 +// returns [ 54.0, -80.0 ] ``` The function has the following additional parameters: @@ -123,20 +99,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the ```javascript var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); var out = cdotc.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); -// returns - -var re = realf( out ); -// returns -55 - -var im = imagf( out ); -// returns 23 +// returns [ -55.0, 23.0 ] ```
@@ -170,14 +138,14 @@ function rand() { return new Complex64( discreteUniform( 0, 10 ), discreteUniform( 1, 5 ) ); } -var cx = filledarrayBy( 10, 'complex64', rand ); -console.log( cx.toString() ); +var x = filledarrayBy( 10, 'complex64', rand ); +console.log( x.toString() ); -var cy = filledarrayBy( 10, 'complex64', rand ); -console.log( cy.toString() ); +var y = filledarrayBy( 10, 'complex64', rand ); +console.log( y.toString() ); -// Perform dot product of cx and cy -var out = cdotc.ndarray( cx.length, cx, 1, 0, cy, -1, cy.length-1 ); +// Perform dot product of x and y +var out = cdotc.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); console.log( out ); ``` @@ -189,15 +157,6 @@ console.log( out );
-* * * - -## See Also - -- [`@stdlib/blas/base/zdotc`][@stdlib/blas/base/zdotc]: calculate the dot product of two double-precision complex vectors. -- [`@stdlib/blas/base/cdotu`][@stdlib/blas/base/cdotu]: calculate the dot product without conjugate of x of two single-precision complex vectors. -- [`@stdlib/blas/base/zdotu`][@stdlib/blas/base/zdotu]: calculate the dot product without conjugate of x of two double-precision complex vectors. -- [`@stdlib/blas/cdotc`][@stdlib/blas/cdotc]: calculate the dot product of two single-precision comple vectors. -
@@ -216,16 +175,6 @@ console.log( out ); [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray - - -[@stdlib/blas/base/zdotc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/zdotc - -[@stdlib/blas/base/cdotu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/cdotu - -[@stdlib/blas/base/zdotu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/zdotu - -[@stdlib/blas/cdotc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/cdotc - diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js index 76aed09d1699..4ae564ea250e 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.js @@ -26,7 +26,6 @@ var pow = require( '@stdlib/math/base/special/pow' ); var Complex64Array = require( '@stdlib/array/complex64' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var pkg = require( './../package.json' ).name; var cdotc = require( './../lib/cdotc.js' ); @@ -48,11 +47,11 @@ var options = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var cx; - var cy; + var x; + var y; - cx = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); - cy = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + x = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + y = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); return benchmark; @@ -68,13 +67,13 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - out = cdotc( cx.length, cx, 1, cy, 1 ); - if ( isnanf( realf( out ) ) || isnanf( imagf( out ) )) { + out = cdotc( x.length, x, 1, y, 1 ); + if ( isnanf( realf( out ) ) ) { b.fail( 'should not return NaN' ); } } b.toc(); - if ( isnanf( realf( out ) ) || isnanf( imagf( out ) )) { + if ( isnanf( realf( out ) ) ) { b.fail( 'should not return NaN' ); } b.pass( 'benchmark finished' ); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js index 04b506e3bd19..75e511633293 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/benchmark/benchmark.ndarray.js @@ -26,7 +26,6 @@ var pow = require( '@stdlib/math/base/special/pow' ); var Complex64Array = require( '@stdlib/array/complex64' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var pkg = require( './../package.json' ).name; var cdotc = require( './../lib/ndarray.js' ); @@ -48,11 +47,11 @@ var options = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var cx; - var cy; + var x; + var y; - cx = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); - cy = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + x = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + y = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); return benchmark; @@ -68,13 +67,13 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - out = cdotc( cx.length, cx, 1, 0, cy, 1, 0 ); - if ( isnanf( realf( out ) ) || isnanf( imagf( out ) )) { + out = cdotc( x.length, x, 1, 0, y, 1, 0 ); + if ( isnanf( realf( out ) ) ) { b.fail( 'should not return NaN' ); } } b.toc(); - if ( isnanf( realf( out ) ) || isnanf( imagf( out ) )) { + if ( isnanf( realf( out ) ) ) { b.fail( 'should not return NaN' ); } b.pass( 'benchmark finished' ); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt index 977e2e46af90..c480e3994495 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt @@ -29,7 +29,7 @@ Returns ------- - out: Complex64 + z: Complex64 The dot product. Examples @@ -37,20 +37,14 @@ // Standard usage: > var x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -1.0, -9.0 ] ); > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0 ] ); - > var out = {{alias}}( x.length, x, 1, y, 1 ); - > var re = {{alias:@stdlib/complex/float32/real}}( out ) - 54 - > var im = {{alias:@stdlib/complex/float32/imag}}( out ) - -80 + > var z = {{alias}}( x.length, x, 1, y, 1 ); + [ 54.0, -80.0 ] // Strides: > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); - > out = {{alias}}( 2, x, 2, y, 1 ); - > var re = {{alias:@stdlib/complex/float32/real}}( out ) - 54 - > var im = {{alias:@stdlib/complex/float32/imag}}( out ) - -80 + > z = {{alias}}( 2, x, 2, y, 1 ); + [ 54.0, -80.0 ] {{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) @@ -85,7 +79,7 @@ Returns ------- - out: Complex64 + z: Complex64 The dot product. Examples @@ -93,29 +87,20 @@ // Standard usage: > var x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -1.0, -9.0 ] ); > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0 ] ); - > var out = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ); - > var re = {{alias:@stdlib/complex/float32/real}}( out ) - 54 - > var im = {{alias:@stdlib/complex/float32/imag}}( out ) - -80 + > var z = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ); + [ 54.0, -80.0 ] // Strides: > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); - > out = {{alias}}.ndarray( 2, x, 2, 0, y, 1, 0 ); - > var re = {{alias:@stdlib/complex/float32/real}}( out ) - 54 - > var im = {{alias:@stdlib/complex/float32/imag}}( out ) - -80 + > z = {{alias}}.ndarray( 2, x, 2, 0, y, 1, 0 ); + [ 54.0, -80.0 ] // Using offset indices: > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); - > out = {{alias}}.ndarray( 2, x, -2, x.length-1, y, 1, 1 ); - > var re = {{alias:@stdlib/complex/float32/real}}( out ) - 61 - > var im = {{alias:@stdlib/complex/float32/imag}}( out ) - -72 + > z = {{alias}}.ndarray( 2, x, -2, x.length-1, y, 1, 1 ); + [ 54.0, -80.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/index.d.ts index 949080bec76a..b29f3902dddf 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/cdotc/docs/types/index.d.ts @@ -25,9 +25,9 @@ import { Complex64Array } from '@stdlib/types/array'; /** * Interface describing `cdotc`. */ -interface Routine { +interface Rzine { /** - * Computes the dot product of two single-precision complex vectors. + * Computes the dot product `x^H * y` of `x` and `y`. * * @param N - number of indexed elements * @param x - first input complex array @@ -43,12 +43,12 @@ interface Routine { * var y = new Complex64Array( [ 6, -6, -9, 5 ] ); * * var z = cdotc( x.length, x, 1, y, 1 ); - * // returns + * // returns [ 54.0, -80.0 ] */ ( N: number, x: Complex64Array, strideX: number, y: Complex64Array, strideY: number ): Complex64; /** - * Computes the dot product of `x` and `y` using alternative indexing semantics. + * Computes the dot product `x^H * y` of `x` and `y` using alternative indexing semantics. * * @param N - number of indexed elements * @param x - first input array @@ -66,13 +66,13 @@ interface Routine { * var y = new Complex64Array( [ 6, -6, -9, 5 ] ); * * var z = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); - * // returns + * // returns [ 54.0, -80.0 ] */ ndarray( N: number, x: Complex64Array, strideX: number, offsetX: number, y: Complex64Array, strideY: number, offsetY: number ): Complex64; } /** -* Computes the dot product of `x` and `y`. +* Computes the dot product `x^H * y` of `x` and `y`. * * @param N - number of indexed elements * @param x - first input array @@ -88,7 +88,7 @@ interface Routine { * var y = new Complex64Array( [ 6, -6, -9, 5 ] ); * * var z = cdotc( x.length, x, 1, y, 1 ); -* // returns +* // returns [ 54.0, -80.0 ] * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); @@ -97,9 +97,9 @@ interface Routine { * var y = new Complex64Array( [ 6, -6, -9, 5 ] ); * * var z = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); -* // returns +* // returns [ 54.0, -80.0 ] */ -declare var cdotc: Routine; +declare var cdotc: Rzine; // EXPORTS // diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js b/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js index 4beccfc55d72..02a5e9a48b36 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js @@ -27,12 +27,15 @@ function rand() { return new Complex64( discreteUniform( 0, 10 ), discreteUniform( 1, 5 ) ); } -var cx = filledarrayBy( 10, 'complex64', rand ); -console.log( cx.toString() ); +var x = filledarrayBy( 10, 'complex64', rand ); +console.log( x.toString() ); -var cy = filledarrayBy( 10, 'complex64', rand ); -console.log( cy.toString() ); +var y = filledarrayBy( 10, 'complex64', rand ); +console.log( y.toString() ); -// Perform dot product of cx and cy -var out = cdotc.ndarray( cx.length, cx, 1, 0, cy, -1, cy.length-1 ); -console.log( out ); +// Perform dot product of x and y +var z = cdotc( x.length, x, 1, 0, y, 1, 0 ); +console.log( z ); + +z = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); +console.log( z ); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js index 0d7cb535ec27..01278fbcc6bc 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/cdotc.js @@ -21,14 +21,13 @@ // MODULES // var stride2offset = require( '@stdlib/strided/base/stride2offset' ); -var Complex64 = require( '@stdlib/complex/float32/ctor' ); var ndarray = require( './ndarray.js' ); // MAIN // /** -* Computes the dot product of `x` and `y`. +* Computes the dot product `x^H * y` of `x` and `y`. * * @param {PositiveInteger} N - number of indexed elements * @param {Complex64Array} x - first input array @@ -40,28 +39,18 @@ var ndarray = require( './ndarray.js' ); * @example * var Complex64Array = require( '@stdlib/array/complex64' ); * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var cdotc = require( '@stdlib/blas/base/cdotc' ); * * var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); * var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); * -* var out = cdotc( x.length, x, 1, y, 1 ); -* // returns -* -* var re = realf( out ); -* // returns 54 -* -* var im = imagf( out ); -* // returns -80 +* var z = cdotc( x.length, x, 1, y, 1 ); +* // returns [ 54.0, -80.0 ] */ function cdotc( N, x, strideX, y, strideY ) { var ix; var iy; - if ( N <= 0 ) { - return new Complex64( 0, 0 ); - } + ix = stride2offset( N, strideX ); iy = stride2offset( N, strideY ); return ndarray( N, x, strideX, ix, y, strideY, iy ); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js index 7edda9aeb5f6..08f53c6045c2 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js @@ -19,46 +19,30 @@ 'use strict'; /** -* BLAS level 1 routine to compute the dot product of two single-precision complex vectors. +* BLAS level 1 routine to compute the dot product `x^H * y` of `x` and `y`. * * @module @stdlib/blas/base/cdotc * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var cdotc = require( '@stdlib/blas/base/cdotc' ); * * var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); * var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); -* var out = cdotc( x.length, x, 1, y, 1 ); -* // returns -* -* var re = realf( out ); -* // returns 54 -* -* var im = imagf( out ); -* // returns -80 +* var z = cdotc( x.length, x, 1, y, 1 ); +* // returns [ 54.0, -80.0 ] * * @example * var Complex64Array = require( '@stdlib/array/complex64' ); * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var cdotc = require( '@stdlib/blas/base/cdotc' ); * * var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); * var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); * -* var out = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); -* // returns -* -* var re = realf( out ); -* // returns 54 -* -* var im = imagf( out ); -* // returns -80 +* var z = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns [ 54.0, -80.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js index 084fa0e243c0..a9961f71b53e 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/ndarray.js @@ -20,8 +20,8 @@ // MODULES // -var cmul = require( '@stdlib/complex/float32/base/mul' ); -var cadd = require( '@stdlib/complex/float32/base/add' ); +var mul = require( '@stdlib/complex/float32/base/mul' ); +var add = require( '@stdlib/complex/float32/base/add' ); var conj = require( '@stdlib/complex/float32/conj' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); @@ -29,7 +29,7 @@ var Complex64 = require( '@stdlib/complex/float32/ctor' ); // MAIN // /** -* Computes the dot product of `x` and `y`. +* Computes the dot product `x^H * y` of `x` and `y`. * * @param {integer} N - number of indexed elements * @param {Complex64Array} x - first input array @@ -43,20 +43,12 @@ var Complex64 = require( '@stdlib/complex/float32/ctor' ); * @example * var Complex64Array = require( '@stdlib/array/complex64' ); * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var x = new Complex64Array( [ 7.0, -8.0, -1.0, -9.0 ] ); * var y = new Complex64Array( [ 6.0, -6.0, -9.0, 5.0 ] ); * -* var out = cdotc( x.length, x, 1, 0, y, 1, 0 ); -* // returns -* -* var re = realf( out ); -* // returns 54 -* -* var im = imagf( out ); -* // returns -80 +* var z = cdotc( x.length, x, 1, 0, y, 1, 0 ); +* // returns [ 54.0, -80.0 ] */ function cdotc( N, x, strideX, offsetX, y, strideY, offsetY ) { var conjX; @@ -73,7 +65,7 @@ function cdotc( N, x, strideX, offsetX, y, strideY, offsetY ) { iy = offsetY; for ( i = 0; i < N; i++ ) { conjX = conj( x.get( ix ) ); - dot = cadd( dot, cmul( conjX, y.get( iy ) ) ); + dot = add( dot, mul( conjX, y.get( iy ) ) ); ix += strideX; iy += strideY; } diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js index b036aa60b7cd..a11772e8cadf 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.cdotc.js @@ -83,7 +83,7 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu t.end(); }); -tape( 'the function supports an `x` stride', function test( t ) { +tape( 'the function supports a `x` stride', function test( t ) { var expected; var dot; var x; @@ -115,40 +115,39 @@ tape( 'the function supports an `x` stride', function test( t ) { t.end(); }); -tape( 'the function supports complex access patterns', function test( t ) { +tape( 'the function supports a negative `x` stride', function test( t ) { var expected; var dot; var x; var y; x = new Complex64Array([ + -1, // 1 + -9, // 1 7, // 0 -8, // 0 -4, -7, - -1, // 1 - -9, // 1 2, -8 ]); y = new Complex64Array([ - 6, // 1 - -6, // 1 - -9, // 0 - 5, // 0 + 6, // 0 + -6, // 0 + -9, // 1 + 5, // 1 7, -6, 1, -5 ]); - expected = new Complex64( -55, 23 ); - - dot = cdotc( 2, x, 2, y, -1 ); + expected = new Complex64( 54, -80 ); + dot = cdotc( 2, x, -1, y, 1 ); t.deepEqual( dot, expected, 'returns expected value' ); t.end(); }); -tape( 'the function supports an `y` stride', function test( t ) { +tape( 'the function supports a `y` stride', function test( t ) { var expected; var dot; var x; @@ -181,6 +180,39 @@ tape( 'the function supports an `y` stride', function test( t ) { t.end(); }); +tape( 'the function supports a negative `y` stride', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, // 1 + -7, // 1 + -1, + -9, + 2, + -8 + ]); + y = new Complex64Array([ + 7, // 1 + -6, // 1 + 6, // 0 + -6, // 0 + -9, + 5, + 1, + -5 + ]); + expected = new Complex64( 104, 79 ); + + dot = cdotc( 2, x, 1, y, -1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + tape( 'the function supports negative strides', function test( t ) { var expected; var dot; @@ -213,3 +245,36 @@ tape( 'the function supports negative strides', function test( t ) { t.deepEqual( dot, expected, 'returns expected value' ); t.end(); }); + +tape( 'the function supports complex access patterns', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, + -7, + -1, // 1 + -9, // 1 + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 1 + -6, // 1 + -9, // 0 + 5, // 0 + 7, + -6, + 1, + -5 + ]); + expected = new Complex64( -55, 23 ); + + dot = cdotc( 2, x, 2, y, -1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js index a333a7f60c40..f551f5110e54 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/test/test.ndarray.js @@ -83,7 +83,7 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu t.end(); }); -tape( 'the function supports an `x` stride', function test( t ) { +tape( 'the function supports a `x` stride', function test( t ) { var expected; var dot; var x; @@ -115,40 +115,67 @@ tape( 'the function supports an `x` stride', function test( t ) { t.end(); }); -tape( 'the function supports complex access patterns', function test( t ) { +tape( 'the function supports a negative `x` stride', function test( t ) { var expected; var dot; var x; var y; x = new Complex64Array([ + -1, // 1 + -9, // 1 7, // 0 -8, // 0 -4, -7, - -1, // 1 - -9, // 1 2, -8 ]); y = new Complex64Array([ - 6, // 1 - -6, // 1 - -9, // 0 - 5, // 0 + 6, // 0 + -6, // 0 + -9, // 1 + 5, // 1 7, -6, 1, -5 ]); - expected = new Complex64( -55, 23 ); + expected = new Complex64( 54, -80 ); + dot = cdotc( 2, x, -1, 1, y, 1, 0 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); - dot = cdotc( 2, x, 2, 0, y, -1, 1 ); +tape( 'the function supports a `x` offset', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 0.0, + 0.0, + 1.0, // 0 + 2.0, // 0 + 3.0, // 1 + 4.0 // 1 + ]); + y = new Complex64Array([ + -5.0, // 0 + 1.0, // 0 + -6.0, // 1 + 7.0 // 1 + ]); + expected = new Complex64( 7.0, 56.0 ); + + dot = cdotc( 2, x, 1, 1, y, 1, 0 ); t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); }); -tape( 'the function supports an `y` stride', function test( t ) { +tape( 'the function supports a `y` stride', function test( t ) { var expected; var dot; var x; @@ -181,6 +208,67 @@ tape( 'the function supports an `y` stride', function test( t ) { t.end(); }); +tape( 'the function supports a negative `y` stride', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, // 1 + -7, // 1 + -1, + -9, + 2, + -8 + ]); + y = new Complex64Array([ + 7, // 1 + -6, // 1 + 6, // 0 + -6, // 0 + -9, + 5, + 1, + -5 + ]); + expected = new Complex64( 104, 79 ); + + dot = cdotc( 2, x, 1, 0, y, -1, 1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` offset', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 1.0, // 0 + 2.0, // 0 + 3.0, // 1 + 4.0 // 1 + ]); + y = new Complex64Array([ + 0.0, + 0.0, + -5.0, // 0 + 1.0, // 0 + -6.0, // 1 + 7.0 // 1 + ]); + expected = new Complex64( 7.0, 56.0 ); + + dot = cdotc( 2, x, 1, 0, y, 1, 1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports negative strides', function test( t ) { var expected; var dot; @@ -213,3 +301,36 @@ tape( 'the function supports negative strides', function test( t ) { t.deepEqual( dot, expected, 'returns expected value' ); t.end(); }); + +tape( 'the function supports complex access patterns', function test( t ) { + var expected; + var dot; + var x; + var y; + + x = new Complex64Array([ + 7, // 0 + -8, // 0 + -4, + -7, + -1, // 1 + -9, // 1 + 2, + -8 + ]); + y = new Complex64Array([ + 6, // 1 + -6, // 1 + -9, // 0 + 5, // 0 + 7, + -6, + 1, + -5 + ]); + expected = new Complex64( -55, 23 ); + + dot = cdotc( 2, x, 2, 0, y, -1, 1 ); + t.deepEqual( dot, expected, 'returns expected value' ); + t.end(); +}); From 5d0a0aa104b47ebaa7bcc56a49e4fcf05a65c59e Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 13 Jun 2025 13:01:10 +0530 Subject: [PATCH 08/12] chore: minor clean-up Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js b/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js index 08f53c6045c2..75513172ed8e 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/lib/index.js @@ -68,4 +68,4 @@ if ( isError( tmp ) ) { module.exports = cdotc; -// exports: { "ndarray": "sdot.ndarray" } +// exports: { "ndarray": "cdotc.ndarray" } From 862b74c443226511832fe207c021a7f2f3fa6036 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 13 Jun 2025 13:29:25 +0530 Subject: [PATCH 09/12] chore: minor clean-up Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js b/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js index 02a5e9a48b36..6ad42d3322f4 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/cdotc/examples/index.js @@ -34,7 +34,7 @@ var y = filledarrayBy( 10, 'complex64', rand ); console.log( y.toString() ); // Perform dot product of x and y -var z = cdotc( x.length, x, 1, 0, y, 1, 0 ); +var z = cdotc( x.length, x, 1, y, 1 ); console.log( z ); z = cdotc.ndarray( x.length, x, 1, 0, y, 1, 0 ); From de970d606c404b5a785af985928f905b4b00fdde Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 13 Jun 2025 13:33:04 +0530 Subject: [PATCH 10/12] chore: minor clean-up Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt index c480e3994495..85e6ae5b0fee 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt @@ -37,13 +37,13 @@ // Standard usage: > var x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -1.0, -9.0 ] ); > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0 ] ); - > var z = {{alias}}( x.length, x, 1, y, 1 ); + > var z = {{alias}}( x.length, x, 1, y, 1 ) [ 54.0, -80.0 ] // Strides: > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); - > z = {{alias}}( 2, x, 2, y, 1 ); + > z = {{alias}}( 2, x, 2, y, 1 ) [ 54.0, -80.0 ] @@ -87,19 +87,19 @@ // Standard usage: > var x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -1.0, -9.0 ] ); > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0 ] ); - > var z = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ); + > var z = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ) [ 54.0, -80.0 ] // Strides: > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); - > z = {{alias}}.ndarray( 2, x, 2, 0, y, 1, 0 ); + > z = {{alias}}.ndarray( 2, x, 2, 0, y, 1, 0 ) [ 54.0, -80.0 ] // Using offset indices: > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); - > z = {{alias}}.ndarray( 2, x, -2, x.length-1, y, 1, 1 ); + > z = {{alias}}.ndarray( 2, x, -2, x.length-1, y, 1, 1 ) [ 54.0, -80.0 ] See Also From 9798c3e2dd3c390c4d30c082690fae58ed7d45dd Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 13 Jun 2025 13:37:44 +0530 Subject: [PATCH 11/12] chore: minor clean-up Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt index 85e6ae5b0fee..e24cda2fc75a 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt @@ -38,13 +38,13 @@ > var x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -1.0, -9.0 ] ); > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0 ] ); > var z = {{alias}}( x.length, x, 1, y, 1 ) - [ 54.0, -80.0 ] + [ 54.0, -80.0 ] // Strides: > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); > z = {{alias}}( 2, x, 2, y, 1 ) - [ 54.0, -80.0 ] + [ 54.0, -80.0 ] {{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) @@ -88,19 +88,19 @@ > var x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -1.0, -9.0 ] ); > var y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0 ] ); > var z = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ) - [ 54.0, -80.0 ] + [ 54.0, -80.0 ] // Strides: > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); > z = {{alias}}.ndarray( 2, x, 2, 0, y, 1, 0 ) - [ 54.0, -80.0 ] + [ 54.0, -80.0 ] // Using offset indices: > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); > z = {{alias}}.ndarray( 2, x, -2, x.length-1, y, 1, 1 ) - [ 54.0, -80.0 ] + [ 54.0, -80.0 ] See Also -------- From c6c4d097b21c3e3ac0fd9ed8291ae5d24e408ca6 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 13 Jun 2025 13:41:52 +0530 Subject: [PATCH 12/12] chore: minor clean-up Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt index e24cda2fc75a..cade653ad7c5 100644 --- a/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/cdotc/docs/repl.txt @@ -100,7 +100,7 @@ > x = new {{alias:@stdlib/array/complex64}}( [ 7.0, -8.0, -4.0, -7.0, -1.0, -9.0 ] ); > y = new {{alias:@stdlib/array/complex64}}( [ 6.0, -6.0, -9.0, 5.0, 7.0, -6.0 ] ); > z = {{alias}}.ndarray( 2, x, -2, x.length-1, y, 1, 1 ) - [ 54.0, -80.0 ] + [ 61.0, -72.0 ] See Also --------