Complex64

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!

Complex64

64-bit complex number.

Installation

npm install @stdlib/complex-float32-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

varComplex64=require('@stdlib/complex-float32-ctor');

Complex64( real, imag )

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

varz=newComplex64(5.0,3.0);// returns <Complex64>

Properties

Complex64.name

Static property returning the constructor name.

varstr=Complex64.name;// returns 'Complex64'

Complex64.BYTES_PER_ELEMENT

Size (in bytes) of each component.

varnbytes=Complex64.BYTES_PER_ELEMENT;// returns 4

Complex64.prototype.BYTES_PER_ELEMENT

Size (in bytes) of each component.

varz=newComplex64(5.0,3.0);varnbytes=z.BYTES_PER_ELEMENT;// returns 4

Complex64.prototype.byteLength

Length (in bytes) of a complex number.

varz=newComplex64(5.0,3.0);varnbytes=z.byteLength;// returns 8

Instance

A Complex64 instance has the following properties...

re

A read-only property returning the real component.

varz=newComplex64(5.0,3.0);varre=z.re;// returns 5.0

im

A read-only property returning the imaginary component.

varz=newComplex64(5.0,-3.0);varim=z.im;// returns -3.0

Methods

Accessor Methods

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

Complex64.prototype.toString()

Returns a string representation of a Complex64 instance.

varz=newComplex64(5.0,3.0);varstr=z.toString();// returns '5 + 3i'z=newComplex64(-5.0,-3.0);str=z.toString();// returns '-5 - 3i'

Complex64.prototype.toJSON()

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

varz=newComplex64(5.0,-3.0);varo=z.toJSON();/* { "type": "Complex64", "re": 5.0, "im": -3.0 }*/

To revive a Complex64 number from a JSONstring, see @stdlib/complex/float32/reviver.

Notes

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

Examples

varComplex64=require('@stdlib/complex-float32-ctor');varz=newComplex64(3.0,-2.0);console.log('type: %s',typeofz);// => '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":"Complex64","re":3,"im":-2}'

C APIs

Usage

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

stdlib_complex64_t

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

stdlib_complex64_tz=stdlib_complex64( 5.0f, 2.0f );

stdlib_complex64_parts_t

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

floatrealf( conststdlib_complex64_tz ) {
stdlib_complex64_parts_tv;
// Assign a single-precision complex floating-point number:v.value=z;
// Extract the real component:floatre=v.parts[ 0 ];
returnre;
}
// ...// Create a complex number:stdlib_complex64_tz=stdlib_complex64( 5.0f, 2.0f );
// ...// Access the real component:floatre=realf( z );
// returns 5.0f

The union has the following members:

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