128-bit complex number.
npm install @stdlib/complex-float64-ctorWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> 128-bit complex number.
``bash`
npm install @stdlib/complex-float64-ctor
`javascript`
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.
`javascript`
var z = new Complex128( 5.0, 3.0 );
// returns
*
#### Complex128.name
Static property returning the constructor name.
`javascript`
var str = Complex128.name;
// returns 'Complex128'
#### Complex128.BYTES_PER_ELEMENT
Size (in bytes) of each component.
`javascript`
var nbytes = Complex128.BYTES_PER_ELEMENT;
// returns 8
#### Complex128.prototype.BYTES_PER_ELEMENT
Size (in bytes) of each component.
`javascript
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.
`javascript
var z = new Complex128( 5.0, 3.0 );
var nbytes = z.byteLength;
// returns 16
`
A Complex128 instance has the following properties...
#### re
A read-only property returning the real component.
`javascript
var z = new Complex128( 5.0, 3.0 );
var re = z.re;
// returns 5.0
`
#### im
A read-only property returning the imaginary component.
`javascript
var z = new Complex128( 5.0, -3.0 );
var im = z.im;
// returns -3.0
`
*
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.
`javascript
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][json] representation of a Complex128 instance. [JSON.stringify()][mdn-json-stringify] implicitly calls this method when stringifying a Complex128 instance.
`javascript
var z = new Complex128( 5.0, -3.0 );
var o = z.toJSON();
/*
{
"type": "Complex128",
"re": 5.0,
"im": -3.0
}
*/
`
To [revive][mdn-json-parse] a Complex128 number from a [JSON][json] string, see [@stdlib/complex/float64/reviver][@stdlib/complex/float64/reviver].
*
- Both the real and imaginary components are stored as double-precision floating-point numbers.
*
`javascript
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`
#include "stdlib/complex/float64/ctor.h"
#### stdlib_complex128_t
An opaque type definition for a double-precision complex floating-point number.
`c`
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.
`c
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.double
- 1: imaginary component.
#### stdlib_complex128( real, imag )
Returns a double-precision complex floating-point number.
`c`
stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );
The function accepts the following arguments:
- real: [in] double real component.[in] double
- imag: imaginary component.
`c`
stdlib_complex128_t stdlib_complex128( const double real, const double imag );
#### stdlib_complex128_from_float32( real )
Converts a single-precision floating-point number to a double-precision complex floating-point number.
`c`
stdlib_complex128_t z = stdlib_complex128_from_float32( 5.0f );
The function accepts the following arguments:
- real: [in] float real component.
`c`
stdlib_complex128_t stdlib_complex128_from_float32( const float real );
#### stdlib_complex128_from_float64( real )
Converts a double-precision floating-point number to a double-precision complex floating-point number.
`c`
stdlib_complex128_t z = stdlib_complex128_from_float64( 5.0 );
The function accepts the following arguments:
- real: [in] double real component.
`c`
stdlib_complex128_t stdlib_complex128_from_float64( const double real );
#### stdlib_complex128_from_complex64( z )
Converts a single-precision complex floating-point number to a double-precision complex floating-point number.
`c
#include "stdlib/complex/float32/ctor.h"
stdlib_complex64_t z1 = stdlib_complex64( 5.0f, 3.0f );
stdlib_complex128_t z2 = stdlib_complex128_from_complex64( z1 );
`
The function accepts the following arguments:
- z: [in] stdlib_complex64_t single-precision complex floating-point number.
`c`
stdlib_complex128_t stdlib_complex128_from_complex64( const stdlib_complex64_t z );
#### stdlib_complex128_from_complex128( z )
Converts (copies) a double-precision complex floating-point number to a double-precision complex floating-point number.
`c`
stdlib_complex128_t z1 = stdlib_complex128( 5.0, 3.0 );
stdlib_complex128_t z2 = stdlib_complex128_from_complex128( z1 );
The function accepts the following arguments:
- z: [in] stdlib_complex128_t double-precision complex floating-point number.
`c`
stdlib_complex128_t stdlib_complex128_from_complex128( const stdlib_complex128_t z );
#### stdlib_complex128_from_int8( real )
Converts a signed 8-bit integer to a double-precision complex floating-point number.
`c`
stdlib_complex128_t z = stdlib_complex128_from_int8( 5 );
The function accepts the following arguments:
- real: [in] int8_t real component.
`c`
stdlib_complex128_t stdlib_complex128_from_int8( const int8_t real );
#### stdlib_complex128_from_uint8( real )
Converts an unsigned 8-bit integer to a double-precision complex floating-point number.
`c`
stdlib_complex128_t z = stdlib_complex128_from_uint8( 5 );
The function accepts the following arguments:
- real: [in] uint8_t real component.
`c`
stdlib_complex128_t stdlib_complex128_from_uint8( const uint8_t real );
#### stdlib_complex128_from_int16( real )
Converts a signed 16-bit integer to a double-precision complex floating-point number.
`c`
stdlib_complex128_t z = stdlib_complex128_from_int16( 5 );
The function accepts the following arguments:
- real: [in] int16_t real component.
`c`
stdlib_complex128_t stdlib_complex128_from_int16( const int16_t real );
#### stdlib_complex128_from_uint16( real )
Converts an unsigned 16-bit integer to a double-precision complex floating-point number.
`c`
stdlib_complex128_t z = stdlib_complex128_from_uint16( 5 );
The function accepts the following arguments:
- real: [in] uint16_t real component.
`c`
stdlib_complex128_t stdlib_complex128_from_uint16( const uint16_t real );
#### stdlib_complex128_from_int32( real )
Converts a signed 32-bit integer to a double-precision complex floating-point number.
`c`
stdlib_complex128_t z = stdlib_complex128_from_int32( 5 );
The function accepts the following arguments:
- real: [in] int32_t real component.
`c`
stdlib_complex128_t stdlib_complex128_from_int32( const int32_t real );
#### stdlib_complex128_from_uint32( real )
Converts an unsigned 32-bit integer to a double-precision complex floating-point number.
`c`
stdlib_complex128_t z = stdlib_complex128_from_uint32( 5 );
The function accepts the following arguments:
- real: [in] uint32_t real component.
`c`
stdlib_complex128_t stdlib_complex128_from_uint32( const uint32_t real );
#### stdlib_complex128_to_complex64( z )
Converts a double-precision complex floating-point number to a single-precision complex floating-point number.
`c
#include "stdlib/complex/float32/ctor.h"
stdlib_complex128_t z1 = stdlib_complex128( 5.0, 3.0 );
stdlib_complex64_t z2 = stdlib_complex128_to_complex64( z1 );
`
The function accepts the following arguments:
- z: [in] stdlib_complex64_t double-precision complex floating-point number.
`c`
stdlib_complex64_t stdlib_complex128_to_complex64( const stdlib_complex128_t z );
`c
#include "stdlib/complex/float64/ctor.h"
#include
#include
/**
* Return the real component of a double-precision complex floating-point number.
*
* @param z complex number
* @return real component
*/
static 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;
}
/**
* Return the imaginary component of a double-precision complex floating-point number.
*
* @param z complex number
* @return imaginary component
*/
static double imag( const stdlib_complex128_t z ) {
stdlib_complex128_parts_t v;
// Assign a double-precision complex floating-point number:
v.value = z;
// Extract the imaginary component:
double im = v.parts[ 1 ];
return im;
}
int main( void ) {
const stdlib_complex128_t x[] = {
stdlib_complex128( 5.0, 2.0 ),
stdlib_complex128( -2.0, 1.0 ),
stdlib_complex128( 0.0, -0.0 ),
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
};
stdlib_complex128_t v;
int i;
for ( i = 0; i < 4; i++ ) {
v = x[ i ];
printf( "%lf + %lfi\n", real( v ), imag( v ) );
}
}
`
*
- [@stdlib/complex-cmplx][@stdlib/complex/cmplx]: create a complex number.
- [@stdlib/complex-float32/ctor][@stdlib/complex/float32/ctor]: 64-bit complex number.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/complex-float64-ctor.svg
[npm-url]: https://npmjs.org/package/@stdlib/complex-float64-ctor
[test-image]: https://github.com/stdlib-js/complex-float64-ctor/actions/workflows/test.yml/badge.svg?branch=v0.1.2
[test-url]: https://github.com/stdlib-js/complex-float64-ctor/actions/workflows/test.yml?query=branch:v0.1.2
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/complex-float64-ctor/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/complex-float64-ctor?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/complex-float64-ctor/tree/deno
[deno-readme]: https://github.com/stdlib-js/complex-float64-ctor/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/complex-float64-ctor/tree/umd
[umd-readme]: https://github.com/stdlib-js/complex-float64-ctor/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/complex-float64-ctor/tree/esm
[esm-readme]: https://github.com/stdlib-js/complex-float64-ctor/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/complex-float64-ctor/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/complex-float64-ctor/main/LICENSE
[json]: http://www.json.org/
[mdn-json-stringify]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
[mdn-json-parse]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse
[@stdlib/complex/float64/reviver]: https://www.npmjs.com/package/@stdlib/complex-float64-reviver
[@stdlib/complex/cmplx]: https://www.npmjs.com/package/@stdlib/complex-cmplx
[@stdlib/complex/float32/ctor]: https://www.npmjs.com/package/@stdlib/complex-float32-ctor