README

add

$NPM version$ $Build Status$ $Coverage Status$ $dependencies$

Add two complex numbers.

Installation

npm install @stdlib/math-base-ops-cadd

Usage

var cadd = require( '@stdlib/math-base-ops-cadd' );

cadd( [out,] re1, im1, re2, im2 )

Adds two complex numbers where each complex number is comprised of a real component re and an imaginary component im.

var v = cadd( 5.0, 3.0, -2.0, 1.0 );
// returns [ 3.0, 4.0 ]

By default, the function returns real and imaginary components as a two-element array. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.

var Float32Array = require( '@stdlib/array-float32' );

var out = new Float32Array( 2 );

var v = cadd( out, 5.0, 3.0, -2.0, 1.0 );
// returns <Float32Array>[ 3.0, 4.0 ]

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

Examples

var Complex128 = require( '@stdlib/complex-float64' );
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var real = require( '@stdlib/complex-real' );
var imag = require( '@stdlib/complex-imag' );
var cadd = require( '@stdlib/math-base-ops-cadd' );

var re;
var im;
var z1;
var z2;
var z3;
var o;
var i;

for ( i = 0; i < 100; i++ ) {
    re = round( randu()*100.0 ) - 50.0;
    im = round( randu()*100.0 ) - 50.0;
    z1 = new Complex128( re, im );

    re = round( randu()*100.0 ) - 50.0;
    im = round( randu()*100.0 ) - 50.0;
    z2 = new Complex128( re, im );

    o = cadd( real(z1), imag(z1), real(z2), imag(z2) );
    z3 = new Complex128( o[ 0 ], o[ 1 ] );

    console.log( '(%s) + (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
}

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

License

See LICENSE.

@stdlib/math-base-ops-cadd

Usage no npm install needed!