Skip to content
Draft
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
284 changes: 284 additions & 0 deletions lib/node_modules/@stdlib/complex/float64/base/add4/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
<!--

@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.

-->

# add4

> Compute the sum of four double-precision complex floating-point numbers.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var add4 = require( '@stdlib/complex/float64/base/add4' );
```

#### add4( z1, z2, z3, z4 )

Computes the sum of four double-precision complex floating-point numbers.

```javascript
var Complex128 = require( '@stdlib/complex/float64/ctor' );

var z = new Complex128( -1.5, 2.5 );

var v = add4( z, z, z, z );
// returns <Complex128>[ -7.5, 12.5 ]
```

The function supports the following parameters:

- **z1**: first complex number.
- **z2**: second complex number.
- **z3**: third complex number.
- **z4**: fourth complex number.

#### add4.assign( re1, im1, re2, im2, re3, im3, re4, im4, out, strideOut, offsetOut )

Computes the sum of four double-precision complex floating-point numbers and assigns results to a provided output array.

```javascript
var Float64Array = require( '@stdlib/array/float64' );

var out = new Float64Array( 2 );
var v = add4.assign( 5.0, 3.0, -2.0, 1.0, 5.0, 3.0, 1.0, 4.0, out, 1, 0 );
// returns <Float64Array>[ 9.0, 11.0 ]

var bool = ( out === v );
// returns true
```

The function supports the following parameters:

- **re1**: real component of the first complex number.
- **im1**: imaginary component of the first complex number.
- **re2**: real component of the second complex number.
- **im2**: imaginary component of the second complex number.
- **re3**: real component of the third complex number.
- **im3**: imaginary component of the third complex number.
- **re4**: real component of the fourth complex number.
- **im4**: imaginary component of the fourth complex number.
- **out**: output array.
- **strideOut**: stride length for `out`.
- **offsetOut**: starting index for `out`.

#### add4.strided( z1, sz1, oz1, z2, sz2, oz2, z3, sz3, oz3, z4, sz4, oz4, out, so, oo )

Computes the sum of four double-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array.

```javascript
var Float64Array = require( '@stdlib/array/float64' );

var z1 = new Float64Array( [ 5.0, 3.0 ] );
var z2 = new Float64Array( [ -2.0, 1.0 ] );
var z3 = new Float64Array( [ 5.0, 3.0 ] );
var z4 = new Float64Array( [ 1.0, 4.0 ] );
var out = new Float64Array( 2 );

var v = add4.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, z4, 1, 0, out, 1, 0 );
// returns <Float64Array>[ 9.0, 11.0 ]

var bool = ( out === v );
// returns true
```

The function supports the following parameters:

- **z1**: first complex number strided array view.
- **sz1**: stride length for `z1`.
- **oz1**: starting index for `z1`.
- **z2**: second complex number strided array view.
- **sz2**: stride length for `z2`.
- **oz2**: starting index for `z2`.
- **z3**: third complex number strided array view.
- **sz3**: stride length for `z3`.
- **oz3**: starting index for `z3`.
- **z4**: fourth complex number strided array view.
- **sz4**: stride length for `z4`.
- **oz4**: starting index for `z4`.
- **out**: output array.
- **so**: stride length for `out`.
- **oo**: starting index for `out`.

</section>

<!-- /.usage -->

<section class="examples">

## Examples

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

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var add4 = require( '@stdlib/complex/float64/base/add4' );

// Generate arrays of random values:
var z1 = new Complex128Array( discreteUniform( 200, -50, 50 ) );
var z2 = new Complex128Array( discreteUniform( 200, -50, 50 ) );
var z3 = new Complex128Array( discreteUniform( 200, -50, 50 ) );
var z4 = new Complex128Array( discreteUniform( 200, -50, 50 ) );

// Perform element-wise addition:
logEachMap( '(%s) + (%s) + (%s) + (%s) = %s', z1, z2, z3, z4, add4 );
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/complex/float64/base/add4.h"
```

#### stdlib_base_complex128_add4( z1, z2, z3, z4 )

Computes the sum of four double-precision complex floating-point numbers.

```c
#include "stdlib/complex/float64/ctor.h"
#include "stdlib/complex/float64/real.h"
#include "stdlib/complex/float64/imag.h"

stdlib_complex128_t z = stdlib_complex128( 3.0, -2.0 );

stdlib_complex128_t out = stdlib_base_complex128_add4( z, z, z, z );

double re = stdlib_complex128_real( out );
// returns 12.0

double im = stdlib_complex128_imag( out );
// returns -8.0
```

The function accepts the following arguments:

- **z1**: `[in] stdlib_complex128_t` first input value.
- **z2**: `[in] stdlib_complex128_t` second input value.
- **z3**: `[in] stdlib_complex128_t` third input value.
- **z4**: `[in] stdlib_complex128_t` fourth input value.

```c
stdlib_complex128_t stdlib_base_complex128_add4( const stdlib_complex128_t z1, const stdlib_complex128_t z2, const stdlib_complex128_t z3, const stdlib_complex128_t z4 );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/complex/float64/base/add4.h"
#include "stdlib/complex/float64/ctor.h"
#include "stdlib/complex/float64/reim.h"
#include <stdio.h>

int main( void ) {
const stdlib_complex128_t x[] = {
stdlib_complex128( 3.14, 1.5 ),
stdlib_complex128( -3.14, 1.5 ),
stdlib_complex128( 0.0, -0.0 ),
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
};

stdlib_complex128_t v;
stdlib_complex128_t y;
double re;
double im;
int i;
for ( i = 0; i < 4; i++ ) {
v = x[ i ];
stdlib_complex128_reim( v, &re, &im );
printf( "z = %lf + %lfi\n", re, im );

y = stdlib_base_complex128_add4( v, v, v, v );
stdlib_complex128_reim( y, &re, &im );
printf( "add4(z, z, z, z) = %lf + %lfi\n", re, im );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- 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">

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/**
* @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 isnan = require( '@stdlib/math/base/assert/is-nan' );
var Float64Array = require( '@stdlib/array/float64' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var add4 = require( './../lib' );


// VARIABLES //

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


// MAIN //

bench( format( '%s:assign', pkg ), function benchmark( b ) {
var out;
var re;
var im;
var N;
var i;
var j;
var k;

N = 100;
re = uniform( N, -500.0, 500.0, options );
im = uniform( N, -500.0, 500.0, options );

out = new Float64Array( 2 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
j = i % N;
k = ( i+1 ) % N;
out = add4.assign( re[ j ], im[ j ], re[ k ], im[ k ], re[ j ], im[ k ], re[ j ], im[ k ], out, 1, 0 ); // eslint-disable-line max-len
if ( typeof out !== 'object' ) {
b.fail( 'should return an object' );
}
}
b.toc();
if ( isnan( out[ 0 ] ) || isnan( out[ 1 ] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Loading
Loading