JSPM

@stdlib/complex-float64-base-add3

0.1.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 48
  • Score
    100M100P100Q81027F
  • License Apache-2.0

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

Package Exports

  • @stdlib/complex-float64-base-add3
  • @stdlib/complex-float64-base-add3/dist
  • @stdlib/complex-float64-base-add3/dist/index.js
  • @stdlib/complex-float64-base-add3/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/complex-float64-base-add3) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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!

add3

NPM version Build Status Coverage Status

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

Installation

npm install @stdlib/complex-float64-base-add3

Usage

var add3 = require( '@stdlib/complex-float64-base-add3' );

add3( z1, z2, z3 )

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

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

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

var v = add3( z, z, z );
// returns <Complex128>[ -4.5, 7.5 ]

The function supports the following parameters:

  • z1: first complex number.
  • z2: second complex number.
  • z3: third complex number.

add3.assign( re1, im1, re2, im2, re3, im3, out, strideOut, offsetOut )

Computes the sum of three 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 = add3.assign( 5.0, 3.0, -2.0, 1.0, 5.0, 3.0, out, 1, 0 );
// returns <Float64Array>[ 8.0, 7.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.
  • out: output array.
  • strideOut: stride length for out.
  • offsetOut: starting index for out.

add3.strided( z1, sz1, oz1, z2, sz2, oz2, z3, sz3, oz3, out, so, oo )

Computes the sum of three 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 z3 = new Float64Array( [ 5.0, 3.0 ] );
var out = new Float64Array( 2 );

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

Examples

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

// 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 ) );

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

C APIs

Usage

#include "stdlib/complex/float64/base/add3.h"

stdlib_base_complex128_add3( z1, z2, z3 )

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

#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_add3( z, z, z );

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

double im = stdlib_complex128_imag( out );
// returns -6.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.
stdlib_complex128_t stdlib_base_complex128_add3( const stdlib_complex128_t z1, const stdlib_complex128_t z2, const stdlib_complex128_t z3 );

Examples

#include "stdlib/complex/float64/base/add3.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_add3( v, v, v );
        stdlib_complex128_reim( y, &re, &im );
        printf( "add3(z, z, z) = %lf + %lfi\n", re, im );
    }
}

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 © 2016-2026. The Stdlib Authors.