@stdlib/complex-base-wrap-function

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!

wrap

Wrap a function accepting complex number arguments to support providing both real and complex numbers.

Installation

npm install @stdlib/complex-base-wrap-function

Usage

var wrap = require( '@stdlib/complex-base-wrap-function' );

wrap( fcn, nargs, ctor )

Returns a function which wraps a function accepting complex number arguments to support providing both real and complex numbers.

var Complex64 = require( '@stdlib/complex-float32' );
var caddf = require( '@stdlib/math-base-ops-caddf' );

var f = wrap( caddf, 2, Complex64 );
// returns <Function>

The function accepts the following arguments:

• fcn: the function to wrap.
• nargs: the number of arguments to be provided to the wrapped function.
• ctor: complex number constructor for converting real numbers to complex numbers.

Notes

• The returned function assumes that the wrapped function accepts only complex number input arguments (i.e., every argument must be a complex number).
• The returned function assumes that, if an input argument is non-numeric (i.e., not of type number), then the input argument is a complex number. The returned function does not verify that non-numeric input arguments are, in fact, complex number objects. The returned function passes non-numeric input arguments to the wrapped function without modification.

Examples

var Complex64 = require( '@stdlib/complex-float32' );
var caddf = require( '@stdlib/math-base-ops-caddf' );
var realf = require( '@stdlib/complex-realf' );
var imagf = require( '@stdlib/complex-imagf' );
var wrap = require( '@stdlib/complex-base-wrap-function' );

var f = wrap( caddf, 2, Complex64 );

// ...

var z = f( 3.0, 4.0 );
// returns <Complex64>

var re = realf( z );
// returns 7.0

var im = imagf( z );
// returns 0.0

console.log( '%d + %di', re, im );
// => '7 + 0i'

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-23)

<section class="features">

Features

• 9768c66 - update minimum TypeScript version

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

• 9768c66: update minimum TypeScript version to 4.1

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

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

Commits

<details>

• 9768c66 - feat: update minimum TypeScript version (by Philipp Burckhardt)
• 32a2827 - fix: update import paths for complex type defs (by Athan Reines)

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

Contributors

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

• Athan Reines
• Philipp Burckhardt

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