@stdlib/complex-reviver

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!

reviveComplex

Revive a JSON-serialized complex number.

Installation

npm install @stdlib/complex-reviver

Usage

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

reviveComplex( key, value )

Revives a JSON-serialized complex number.

var parseJSON = require( '@stdlib/utils-parse-json' );

var str = '{"type":"Complex128","re":5,"im":3}';

var z = parseJSON( str, reviveComplex );
// returns <Complex128>

For details on the JSON serialization format, see Complex128.

Examples

var Complex128 = require( '@stdlib/complex-float64-ctor' );
var parseJSON = require( '@stdlib/utils-parse-json' );
var reviveComplex = require( '@stdlib/complex-reviver' );

var z = new Complex128( 5.0, 3.0 );
var str = JSON.stringify( z );
// returns '{"type":"Complex128","re":5,"im":3}'

var w = parseJSON( str, reviveComplex );
if ( w instanceof Error ) {
    throw w;
}
var bool = ( w instanceof z.constructor );
// returns true

bool = ( w.re === z.re );
// returns true

bool = ( w.im === z.im );
// returns true

---

See Also

• @stdlib/complex-float64/ctor: 128-bit complex number.
• @stdlib/complex-float32/ctor: 64-bit complex number.
• @stdlib/complex-float64/reviver: revive a JSON-serialized 128-bit complex number.
• @stdlib/complex-float32/reviver: revive a JSON-serialized 64-bit complex number.

---

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.