Skip to content

Add two double-precision complex floating-point numbers.

License

Notifications You must be signed in to change notification settings

stdlib-js/complex-float64-base-add

 
 

Repository files navigation

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

add

NPM version Build Status Coverage Status

Add two double-precision complex floating-point numbers.

Usage

To use in Observable,

add = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-base-add@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var add = require( 'path/to/vendor/umd/complex-float64-base-add/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-base-add@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.add;
})();
</script>

add( z1, z2 )

Adds two double-precision complex floating-point numbers.

var Complex128 = require( '@stdlib/complex-float64-ctor' );
var real = require( '@stdlib/complex-float64-real' );
var imag = require( '@stdlib/complex-float64-imag' );

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

var v = add( z, z );
// returns <Complex128>

var re = real( v );
// returns -3.0

var im = imag( v );
// returns 5.0

add.assign( re1, im1, re2, im2, out, strideOut, offsetOut )

Adds two double-precision complex floating-point numbers and assigns results to a provided output array.

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

var out = new Float64Array( 2 );
var v = add.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
// returns <Float64Array>[ 3.0, 4.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.
  • out: output array.
  • strideOut: stride length for out.
  • offsetOut: starting index for out.

add.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )

Adds two double-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array.

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

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

var v = add.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 );
// returns <Float64Array>[ 3.0, 4.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.
  • out: output array.
  • so: stride length for out.
  • oo: starting index for out.

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-ctor@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@umd/browser.js"></script>
<script type="text/javascript">
(function () {.factory;
var add = require( '@stdlib/complex-float64-base-add' );

var rand = discreteUniform( -50, 50 );

var z1;
var z2;
var z3;
var i;
for ( i = 0; i < 100; i++ ) {
    z1 = new Complex128( rand(), rand() );
    z2 = new Complex128( rand(), rand() );
    z3 = add( z1, z2 );
    console.log( '(%s) + (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
}

})();
</script>
</body>
</html>

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.