@stdlib/complex-float64-ctor

128-bit complex number.

https://github.com/stdlib-js/complex-float64-ctor

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary

Keywords

128-bit complex complex128 constructor ctor data double double-precision float64 ieee754 javascript node node-js nodejs stdlib structure types

Last synced: 6 months ago · JSON representation ·

Repository

128-bit complex number.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: C
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 226 KB

Statistics

Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

128-bit complex complex128 constructor ctor data double double-precision float64 ieee754 javascript node node-js nodejs stdlib structure types

Created over 1 year ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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 ```bash 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][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] 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 ```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 ``` * * * ## Properties #### 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 ``` ### Instance 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 ``` * * * ## 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. ```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].

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

## Examples ```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 APIs

### Usage ```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. - **1**: `double` 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. - **imag**: `[in] double` 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 ); ```

### Examples ```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 ) ); } } ```

* * * ## Notice 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] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 37

Last Year

Push event: 37

Packages

Total packages: 1
Total downloads:
- npm 231,065 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 3
Total maintainers: 4

npmjs.org: @stdlib/complex-float64-ctor

128-bit complex number.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.0.3
published over 1 year ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 231,065 Last month

Rankings

Downloads: 20.5%

Dependent repos count: 27.9%

Average: 29.6%

Dependent packages count: 40.5%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
JS-DevTools/npm-publish 4b07b26a2f6e0a51846e1870223e545bae91c552 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/test.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_bundles.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite

.github/workflows/test_coverage.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

benchmark/julia/REQUIRE julia

BenchmarkTools 0.5.0
julia 1.5

package.json npm

@stdlib/assert-has-own-property ^0.2.1 development
@stdlib/bench-harness ^0.2.1 development
@stdlib/math-base-assert-is-nan ^0.2.1 development
@stdlib/random-base-randu ^0.2.1 development
istanbul ^0.4.1 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-is-number ^0.2.1
@stdlib/complex-float32-ctor github:stdlib-js/complex-float32-ctor#main
@stdlib/error-tools-fmtprodmsg ^0.2.1
@stdlib/string-format ^0.2.1
@stdlib/utils-define-nonenumerable-read-only-property ^0.2.1
@stdlib/utils-define-property ^0.2.3
@stdlib/utils-library-manifest ^0.2.1

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/complex-float64-ctor

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Complex128

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Packages

npmjs.org: @stdlib/complex-float64-ctor

Rankings

Maintainers (4)

Funding

Dependencies