Complex128

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!

Complex128

128-bit complex number.

Installation

npm install @stdlib/complex-float64-ctor

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 Complex128 = require( '@stdlib/complex-float64-ctor' );

Complex128( real, imag )

128-bit complex number constructor, where real and imag are the real and imaginary components, respectively.

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

Properties

Complex128.BYTES_PER_ELEMENT

Size (in bytes) of each component.

var nbytes = Complex128.BYTES_PER_ELEMENT;
// returns 8

Complex128.prototype.BYTES_PER_ELEMENT

Size (in bytes) of each component.

var z = new Complex128( 5.0, 3.0 );

var nbytes = z.BYTES_PER_ELEMENT;
// returns 8

Complex128.prototype.byteLength

Length (in bytes) of a complex number.

var z = new Complex128( 5.0, 3.0 );

var nbytes = z.byteLength;
// returns 16

Instance

A Complex128 instance has the following properties...

re

A read-only property returning the real component.

var z = new Complex128( 5.0, 3.0 );

var re = z.re;
// returns 5.0

im

A read-only property returning the imaginary component.

var z = new Complex128( 5.0, -3.0 );

var im = z.im;
// returns -3.0

Methods

Accessor Methods

These methods do not mutate a Complex128 instance and, instead, return a complex number representation.

Complex128.prototype.toString()

Returns a string representation of a Complex128 instance.

var z = new Complex128( 5.0, 3.0 );
var str = z.toString();
// returns '5 + 3i'

z = new Complex128( -5.0, -3.0 );
str = z.toString();
// returns '-5 - 3i'

Complex128.prototype.toJSON()

Returns a JSON representation of a Complex128 instance. JSON.stringify() implicitly calls this method when stringifying a Complex128 instance.

var z = new Complex128( 5.0, -3.0 );

var o = z.toJSON();
/*
  {
    "type": "Complex128",
    "re": 5.0,
    "im": -3.0
  }
*/

To revive a Complex128 number from a JSON string, see @stdlib/complex/float64/reviver.

Notes

Both the real and imaginary components are stored as double-precision floating-point numbers.

Examples

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

var z = new Complex128( 3.0, -2.0 );

console.log( 'type: %s', typeof z );
// => 'type: object'

console.log( 'str: %s', z );
// => 'str: 3 - 2i'

console.log( 'real: %d', z.re );
// => 'real: 3'

console.log( 'imaginary: %d', z.im );
// => 'imaginary: -2'

console.log( 'JSON: %s', JSON.stringify( z ) );
// => 'JSON: {"type":"Complex128","re":3,"im":-2}'

C APIs

Usage

#include "stdlib/complex/float64/ctor.h"

stdlib_complex128_t

An opaque type definition for a double-precision complex floating-point number.

stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );

stdlib_complex128_parts_t

An opaque type definition for a union for accessing the real and imaginary parts of a double-precision complex floating-point number.

double real( const stdlib_complex128_t z ) {
    stdlib_complex128_parts_t v;

    // Assign a double-precision complex floating-point number:
    v.value = z;

    // Extract the real component:
    double re = v.parts[ 0 ];

    return re;
}

// ...

// Create a complex number:
stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );

// ...

// Access the real component:
double re = real( z );
// returns 5.0

The union has the following members:

value: stdlib_complex128_t double-precision complex floating-point number.
parts: double[] array having the following elements:
- 0: double real component.
- 1: double imaginary component.