Skip to content

Latest commit

 

History

History
238 lines (142 loc) · 8.17 KB

README.md

File metadata and controls

238 lines (142 loc) · 8.17 KB
Raw
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!

Complex Numbers

NPM version Build Status Coverage Status

Create a complex number.

Installation

npm install @stdlib/complex-cmplx

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var complex = require( '@stdlib/complex-cmplx' );

complex( real, imag[, dtype] )

Creates a complex number, where real and imag are the real and imaginary components, respectively.

var z = complex( 5.0, 3.0 );
// returns <Complex128>

By default, the function returns a 128-bit complex number. To specify an alternative underlying data type, set the dtype parameter to one of the following:

  • 'float64': store real and imaginary components as double-precision floating-point numbers.
  • 'float32': store real and imaginary components as single-precision floating-point numbers.
var z = complex( 5.0, 3.0, 'float32' );
// returns <Complex64>

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var complex = require( '@stdlib/complex-cmplx' );

var rand = discreteUniform( -50, 50 );

var z;
var i;
for ( i = 0; i < 100; i++ ) {
    z = complex( rand(), rand(), 'float64' );
    console.log( z.toString() );
}

See Also

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

Copyright © 2016-2024. The Stdlib Authors.