@stdlib/complex-parse-float64 v0.1.0

parseComplex128

Parse a string representation of a 128-bit complex number.

Installation

npm install @stdlib/complex-parse-float64

Usage

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

parseComplex128( str )

Parse a string representation of a 128-bit complex number.

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

var str = '5 + 3i';

var z = parseComplex128( str );
// returns <Complex128>

var re = real( z );
// returns 5.0

var im = imag( z );
// returns 3.0

For details on the string format, see Complex128.

Examples

var parseComplex128 = require( '@stdlib/complex-parse-float64' );
var isComplex128 = require( '@stdlib/assert-is-complex128' );
var real = require( '@stdlib/complex-real' );
var imag = require( '@stdlib/complex-imag' );

var str = '1e3 - 2.75i';

var z = parseComplex128( str );
var bool = isComplex128( z );
// returns true

bool = ( real( z ) === 1e3 );
// returns true

bool = ( imag( z ) === -2.75 );
// returns true

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.