Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 132 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/zwxmy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!--

@license Apache-2.0

Copyright (c) 2026 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.

-->

# zwxmy

> Multiply elements of a one-dimensional double-precision complex floating-point ndarray by the corresponding elements of a second one-dimensional double-precision complex floating-point ndarray and assign the results to elements in a third one-dimensional double-precision complex floating-point ndarray.

<section class="intro">

This BLAS extension implements the operation

<!-- <equation class="equation" label="eq:wxmy" align="center" raw="\mathbf{w} = \mathbf{x} \odot \mathbf{y}" alt="Equation for wxmy operation."> -->

```math
\mathbf{w} = \mathbf{x} \odot \mathbf{y}
```

<!-- </equation> -->

where `⊙` denotes the [Hadamard product][hadamard-product].

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var zwxmy = require( '@stdlib/blas/ext/base/ndarray/zwxmy' );
```

#### zwxmy( arrays )

Multiplies elements of a one-dimensional double-precision complex floating-point ndarray by the corresponding elements of a second one-dimensional double-precision complex floating-point ndarray and assigns the results to elements in a third one-dimensional double-precision complex floating-point ndarray.

```javascript
var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );

var x = new Complex128Vector( [ 1.0, 2.0, 3.0, -1.0, 0.0, 1.0 ] );
var y = new Complex128Vector( [ 2.0, 1.0, -1.0, 3.0, 4.0, 0.0 ] );
var w = new Complex128Vector( 3 );

zwxmy( [ x, y, w ] );
// w => <ndarray>[ <Complex128>[ 0.0, 5.0 ], <Complex128>[ 0.0, 10.0 ], <Complex128>[ 0.0, 4.0 ] ]
```

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- first one-dimensional input ndarray.
- second one-dimensional input ndarray.
- a one-dimensional output ndarray.

</section>

<!-- /.usage -->

<section class="notes">

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var zwxmy = require( '@stdlib/blas/ext/base/ndarray/zwxmy' );

var opts = {
'dtype': 'float64'
};

var x = new Complex128Vector( discreteUniform( 20, -100, 100, opts ) );
console.log( ndarray2array( x ) );

var y = new Complex128Vector( discreteUniform( 20, -100, 100, opts ) );
console.log( ndarray2array( y ) );

var w = new Complex128Vector( 10 );

zwxmy( [ x, y, w ] );
console.log( ndarray2array( w ) );
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[hadamard-product]: https://en.wikipedia.org/wiki/Hadamard_product_(matrices)

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var zwxmy = require( './../lib' );


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - ndarray length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var xbuf;
var ybuf;
var x;
var y;
var w;

xbuf = uniform( len*2, -100.0, 100.0, {
'dtype': 'float64'
});
ybuf = uniform( len*2, -100.0, 100.0, {
'dtype': 'float64'
});
x = new Complex128Vector( xbuf.buffer );
y = new Complex128Vector( ybuf.buffer );
w = new Complex128Vector( len );
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 = zwxmy( [ x, y, w ] );
if ( typeof out !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( typeof out !== 'object' ) {
b.fail( 'should return an ndarray' );
}
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( format( '%s:len=%d', pkg, len ), f );
}
}

main();
34 changes: 34 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/zwxmy/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

{{alias}}( arrays )
Multiplies elements of a one-dimensional double-precision complex floating-
point ndarray by the corresponding elements of a second one-dimensional
double-precision complex floating-point ndarray and assigns the results to
elements in a third one-dimensional double-precision complex floating-point
ndarray.

Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing the following ndarrays:

- first one-dimensional input ndarray.
- second one-dimensional input ndarray.
- a one-dimensional output ndarray.

Returns
-------
out: ndarray
Output ndarray.

Examples
--------
> var xbuf = [ 1.0, 2.0, 3.0, -1.0 ];
> var x = new {{alias:@stdlib/ndarray/vector/complex128}}( xbuf );
> var ybuf = [ 2.0, 1.0, -1.0, 3.0 ];
> var y = new {{alias:@stdlib/ndarray/vector/complex128}}( ybuf );
> var w = new {{alias:@stdlib/ndarray/vector/complex128}}( 2 );
> {{alias}}( [ x, y, w ] )
<ndarray>[ <Complex128>[ 0.0, 5.0 ], <Complex128>[ 0.0, 10.0 ] ]

See Also
--------
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { complex128ndarray } from '@stdlib/types/ndarray';

/**
* Multiplies elements of a one-dimensional double-precision complex floating-point ndarray by the corresponding elements of a second one-dimensional double-precision complex floating-point ndarray and assigns the results to elements in a third one-dimensional double-precision complex floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second one-dimensional input ndarray.
* - a one-dimensional output ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
*
* var x = new Complex128Vector( [ 1.0, 2.0, 3.0, -1.0, 0.0, 1.0 ] );
* var y = new Complex128Vector( [ 2.0, 1.0, -1.0, 3.0, 4.0, 0.0 ] );
* var w = new Complex128Vector( 3 );
*
* var out = zwxmy( [ x, y, w ] );
* // returns <ndarray>[ <Complex128>[ 0.0, 5.0 ], <Complex128>[ 0.0, 10.0 ], <Complex128>[ 0.0, 4.0 ] ]
*/
declare function zwxmy( arrays: [ complex128ndarray, complex128ndarray, complex128ndarray ] ): complex128ndarray;


// EXPORTS //

export = zwxmy;
Loading
Loading