@stdlib/complex-float64

What is @stdlib/complex-float64?

@stdlib/complex-float64 is a package for creating and manipulating double-precision complex numbers in JavaScript. It provides a variety of utilities for complex number arithmetic, including creation, basic operations, and conversions.

What are @stdlib/complex-float64's main functionalities?

Creating a Complex Number

This feature allows you to create a new double-precision complex number. The example creates a complex number with a real part of 5.0 and an imaginary part of 3.0.

const Complex64 = require('@stdlib/complex-float64');
const z = new Complex64(5.0, 3.0);
console.log(z);

Basic Arithmetic Operations

This feature allows you to perform basic arithmetic operations on complex numbers. The example demonstrates how to add two complex numbers.

const Complex64 = require('@stdlib/complex-float64');
const z1 = new Complex64(5.0, 3.0);
const z2 = new Complex64(2.0, 1.0);
const sum = z1.add(z2);
console.log(sum);

Converting to String

This feature allows you to convert a complex number to a string representation. The example converts a complex number to its string form.

const Complex64 = require('@stdlib/complex-float64');
const z = new Complex64(5.0, 3.0);
console.log(z.toString());

Other packages similar to @stdlib/complex-float64

complex.js

complex.js is a library for complex number arithmetic in JavaScript. It provides a comprehensive set of functions for complex number operations, including addition, subtraction, multiplication, division, and more. Compared to @stdlib/complex-float64, complex.js offers a more extensive set of mathematical functions and utilities for complex numbers.

mathjs

mathjs is an extensive mathematics library for JavaScript and Node.js. It includes support for complex numbers, matrices, units, and more. The complex number functionality in mathjs is part of a larger suite of mathematical tools, making it a more versatile but also more heavyweight option compared to @stdlib/complex-float64.

README

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

Double-precision complex floating-point number functions.

Installation

npm install @stdlib/complex-float64

Usage

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

complex

Namespace containing double-precision complex floating-point number functions.

var ns = complex;
// returns {...}

The namespace contains the following sub-namespaces:

• base: base (i.e., lower-level) double-precision complex floating-point number functions.

The namespace contains the following functions:

• conj( z ): return the complex conjugate of a double-precision complex floating-point number.
• Complex128( real, imag ): 128-bit complex number.
• imag( z ): return the imaginary component of a double-precision complex floating-point number.
• parseComplex128( str ): parse a string representation of a 128-bit complex number.
• real( z ): return the real component of a double-precision complex floating-point number.
• reim( z ): return the real and imaginary components of a double-precision complex floating-point number.
• reviveComplex128( key, value ): revive a JSON-serialized 128-bit complex number.

Examples

var objectKeys = require( '@stdlib/utils-keys' );
var ns = require( '@stdlib/complex-float64' );

console.log( objectKeys( ns ) );

---

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

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.3.0 (2024-07-28)

<section class="packages">

Packages

<section class="package" id="complex-float64-v0.3.0">