@stdlib/complex-float32-base-add

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

Add two single-precision complex floating-point numbers.

Installation

npm install @stdlib/complex-float32-base-add

Usage

var add = require( '@stdlib/complex-float32-base-add' );

add( z1, z2 )

Adds two single-precision complex floating-point numbers.

var Complex64 = require( '@stdlib/complex-float32-ctor' );
var realf = require( '@stdlib/complex-float32-real' );
var imagf = require( '@stdlib/complex-float32-imag' );

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

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

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

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

Examples

var Complex64 = require( '@stdlib/complex-float32-ctor' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var add = require( '@stdlib/complex-float32-base-add' );

var rand = discreteUniform( -50, 50 );

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

---

C APIs

Usage

#include "stdlib/complex/float32/base/add.h"

stdlib_base_complex64_add( z1, z2 )

Adds two single-precision complex floating-point numbers.

#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/real.h"
#include "stdlib/complex/float32/imag.h"

stdlib_complex64_t z = stdlib_complex64( 3.0f, -2.0f );

stdlib_complex64_t out = stdlib_base_complex64_add( z, z );

float re = stdlib_complex64_real( out );
// returns 6.0f

float im = stdlib_complex64_imag( out );
// returns -4.0f

The function accepts the following arguments:

• z1: [in] stdlib_complex64_t input value.
• z2: [in] stdlib_complex64_t input value.

stdlib_complex64_t stdlib_base_complex64_add( const stdlib_complex64_t z1, const stdlib_complex64_t z2 );

Examples

#include "stdlib/complex/float32/base/add.h"
#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/reim.h"
#include <stdio.h>

int main( void ) {
    const stdlib_complex64_t x[] = {
        stdlib_complex64( 3.14f, 1.5f ),
        stdlib_complex64( -3.14f, 1.5f ),
        stdlib_complex64( 0.0f, -0.0f ),
        stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )
    };

    stdlib_complex64_t v;
    stdlib_complex64_t y;
    float re;
    float im;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = x[ i ];
        stdlib_complex64_reim( v, &re, &im );
        printf( "z = %f + %fi\n", re, im );

        y = stdlib_base_complex64_add( v, v );
        stdlib_complex64_reim( y, &re, &im );
        printf( "add(z, z) = %f + %fi\n", re, im );
    }
}

---

See Also

• @stdlib/complex-float64/base/add: add two double-precision complex floating-point numbers.
• @stdlib/complex-float32/base/mul: multiply two single-precision complex floating-point numbers.
• @stdlib/math-base/ops/csubf: subtract two single-precision complex floating-point numbers.

---

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.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.1.0 (2024-07-28)

<section class="features">

Features

• 10ef39d - add complex/float32/base/add

</section> <!-- /.features --> <section class="commits">

Commits

<details>

• 2777e4b - bench: resolve lint errors in benchmarks (by Athan Reines)
• ddd4403 - refactor: update paths (by Athan Reines)
• 0406147 - refactor: update paths (by Athan Reines)
• 10ef39d - feat: add complex/float32/base/add (by Athan Reines)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 1 person contributed to this release. Thank you to this contributor:

• Athan Reines

</section> <!-- /.contributors --> </section> <!-- /.release -->