@stdlib/math-base-special-cexp

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!

exp

Evaluate the exponential function for a double-precision complex floating-point number.

The exponential function of a complex number is defined as

Installation

npm install @stdlib/math-base-special-cexp

Usage

var cexp = require( '@stdlib/math-base-special-cexp' );

cexp( z )

Evaluates the exponential function for a double-precision complex floating-point number.

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

var v = cexp( new Complex128( 0.0, 0.0 ) );
// returns <Complex128>

var re = real( v );
// returns 1.0

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

v = cexp( new Complex128( 0.0, 1.0 ) );
// returns <Complex128>

re = real( v );
// returns ~0.540

im = imag( v );
// returns ~0.841

Examples

var Complex128 = require( '@stdlib/complex-float64' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var cexp = require( '@stdlib/math-base-special-cexp' );

function randomComplex() {
    var re = discreteUniform( -50, 50 );
    var im = discreteUniform( -50, 50 );
    return new Complex128( re, im );
}

var z1;
var z2;
var i;
for ( i = 0; i < 100; i++ ) {
    z1 = randomComplex();
    z2 = cexp( z1 );
    console.log( 'cexp(%s) = %s', z1.toString(), z2.toString() );
}

---

C APIs

Usage

#include "stdlib/math/base/special/cexp.h"

stdlib_base_cexp( z )

Evaluates the exponential function for a double-precision complex floating-point number.

#include "stdlib/complex/float64.h"
#include "stdlib/complex/real.h"
#include "stdlib/complex/imag.h"

stdlib_complex128_t z = stdlib_complex128( 0.0, 0.0 );
stdlib_complex128_t out = stdlib_base_cexp( z );

double re = stdlib_real( out );
// returns 1.0

double im = stdlib_imag( out );
// returns 0.0

The function accepts the following arguments:

• z: [in] stdlib_complex128_t input value.

stdlib_complex128_t stdlib_base_cexp( const stdlib_complex128_t z );

Examples

#include "stdlib/math/base/special/cexp.h"
#include "stdlib/complex/float64.h"
#include "stdlib/complex/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 re1;
    double im1;
    double re2;
    double im2;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = x[ i ];
        y = stdlib_base_cexp( v );
        stdlib_reim( v, &re1, &im1 );
        stdlib_reim( y, &re2, &im2 );
        printf( "cexp(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 );
    }
}

---

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-2023. The Stdlib Authors.

Changelog

0.1.0 (2023-09-24)

<section class="features">

Features

• 58832ee - update minimum TypeScript version
• 5318182 - refactor API and add C API to math/base/special/cexp (#972)

</section> <!-- /.features --> <section class="bug-fixes">

Bug Fixes

• 32a2827 - update import paths for complex type defs

</section> <!-- /.bug-fixes --> <section class="breaking-changes">

BREAKING CHANGES

• 58832ee: update minimum TypeScript version to 4.1

  • To migrate, users should upgrade their TypeScript version to at least version 4.1.

• 5318182: remove support for out argument

  • To migrate, users should provide a Complex128 object, rather than an output array and real and imaginary components.

</section> <!-- /.breaking-changes --> <section class="commits">

Commits

<details>

• 58832ee - feat: update minimum TypeScript version (by Philipp Burckhardt)
• 32a2827 - fix: update import paths for complex type defs (by Athan Reines)
• a1d78a7 - style: fix indentation in manifest.json files (#1063) (by Stephannie Jiménez Gacha, Athan Reines)
• ce7e336 - docs: update equations (by Philipp Burckhardt)
• 28e1c84 - docs: resolve C lint errors (by Athan Reines)
• bdb7d4f - chore: update package meta data (#1002) (by stdlib-bot, Athan Reines)
• 5318182 - feat: refactor API and add C API to math/base/special/cexp (#972) (by Stephannie Jiménez Gacha, Athan Reines)
• c5da1f9 - docs: render equations via math code blocks (by Philipp Burckhardt)

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

Contributors

A total of 3 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Philipp Burckhardt
• Stephannie Jiménez Gacha

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.0.6">