feat: add complex/parse-float32

PR-URL: stdlib-js#1430 Closes: stdlib-js#1332 --------- Signed-off-by: Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Signed-off-by: Pranav <85227306+Pranavchiku@users.noreply.github.com> Co-authored-by: Pranav <85227306+Pranavchiku@users.noreply.github.com> Reviewed-by: Pranav <85227306+Pranavchiku@users.noreply.github.com>
rajutkarsh07 · Mar 2, 2024 · 514d38f · 514d38f
1 parent 234c6c3
commit 514d38f
Show file tree

Hide file tree

Showing 10 changed files with 728 additions and 0 deletions.
diff --git a/lib/node_modules/@stdlib/complex/parse-float32/README.md b/lib/node_modules/@stdlib/complex/parse-float32/README.md
@@ -0,0 +1,133 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# parseComplex64
+
+> Parse a string representation of a 64-bit [complex number][@stdlib/complex/float32].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var parseComplex64 = require( '@stdlib/complex/parse-float32' );
+```
+
+#### parseComplex64( str )
+
+Parse a string representation of a 64-bit [complex number][@stdlib/complex/float32].
+
+```javascript
+var parseComplex64 = require( '@stdlib/complex/parse-float32' );
+var real = require( '@stdlib/complex/real' );
+var imag = require( '@stdlib/complex/imag' );
+
+var str = '5 + 3i';
+
+var z = parseComplex64( str );
+// returns <Complex64>
+
+var re = real( z );
+// returns 5.0
+
+var im = imag( z );
+// returns 3.0
+```
+
+For details on the string format, see [Complex64][@stdlib/complex/float32].
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var parseComplex64 = require( '@stdlib/complex/parse-float32' );
+var isComplex64 = require( '@stdlib/assert/is-complex64' );
+var real = require( '@stdlib/complex/real' );
+var imag = require( '@stdlib/complex/imag' );
+
+var str = '1e3 - 2.75i';
+
+var z = parseComplex64( str );
+var bool = isComplex64( z );
+// returns true
+
+bool = ( real( z ) === 1e3 );
+// returns true
+
+bool = ( imag( z ) === -2.75 );
+// returns true
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/complex/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32
+
+</section>
+
+<!-- /.links -->
diff --git a/lib/node_modules/@stdlib/complex/parse-float32/benchmark/benchmark.js b/lib/node_modules/@stdlib/complex/parse-float32/benchmark/benchmark.js
@@ -0,0 +1,50 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isComplex64 = require( '@stdlib/assert/is-complex64' );
+var pkg = require( './../package.json' ).name;
+var parse = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var str;
+	var z;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		str = i + ' + ' + (i+1) + 'i';
+		z = parse( str );
+		if ( !(isComplex64(z)) ) {
+			b.fail( 'should return a Complex64' );
+		}
+	}
+	b.toc();
+	if ( !(isComplex64(z)) ) {
+		b.fail( 'should return a Complex64' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
diff --git a/lib/node_modules/@stdlib/complex/parse-float32/docs/repl.txt b/lib/node_modules/@stdlib/complex/parse-float32/docs/repl.txt
@@ -0,0 +1,22 @@
+
+{{alias}}( str )
+    Parse a string representation of a 64-bit complex number.
+
+    Parameters
+    ----------
+    str: string
+        String representation of a complex number.
+
+    Returns
+    -------
+    out: Complex64
+        64-bit complex number.
+
+    Examples
+    --------
+    > var str = '5 + 3i';
+    > var z = {{alias}}( str )
+    <Complex64>
+
+    See Also
+    --------
diff --git a/lib/node_modules/@stdlib/complex/parse-float32/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/parse-float32/docs/types/index.d.ts
@@ -0,0 +1,46 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+// MODULES //
+
+/// <reference types="@stdlib/types"/>
+
+import { Complex64 } from '@stdlib/types/complex';
+
+
+/**
+* Parse a string representation of a 64-bit complex number.
+*
+* @param str - string representation of a complex number
+* @returns Complex64 instance
+* @throws must provide a string recognized as a complex number
+*
+* @example
+* var str = '5 + 3i';
+*
+* var z = parseComplex64( str );
+* // returns <Complex64>
+*/
+declare function parseComplex64( str: string ): Complex64;
+
+
+// EXPORTS //
+
+export = parseComplex64;
diff --git a/lib/node_modules/@stdlib/complex/parse-float32/docs/types/test.ts b/lib/node_modules/@stdlib/complex/parse-float32/docs/types/test.ts
@@ -0,0 +1,44 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import parseComplex64 = require( './index' );
+
+
+// TESTS //
+
+// The function returns a complex number...
+{
+	parseComplex64( '5 + 3.5i' ); // $ExpectType Complex64
+	parseComplex64( '3' ); // $ExpectType Complex64
+	parseComplex64( '-8i' ); // $ExpectType Complex64
+	parseComplex64( '1e3 + 1e-3i' ); // $ExpectType Complex64
+	parseComplex64( 'NaN + NaNi' ); // $ExpectType Complex64
+	parseComplex64( 'Infinity - Infinityi' ); // $ExpectType Complex64
+}
+
+// The compiler throws an error if the function is provided a first argument that is not a string...
+{
+	parseComplex64( true ); // $ExpectError
+	parseComplex64( false ); // $ExpectError
+	parseComplex64( null ); // $ExpectError
+	parseComplex64( undefined ); // $ExpectError
+	parseComplex64( 5 ); // $ExpectError
+	parseComplex64( [] ); // $ExpectError
+	parseComplex64( {} ); // $ExpectError
+	parseComplex64( ( x: number ): number => x ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/complex/parse-float32/examples/index.js b/lib/node_modules/@stdlib/complex/parse-float32/examples/index.js
@@ -0,0 +1,42 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+var isComplex64 = require( '@stdlib/assert/is-complex64' );
+var real = require( '@stdlib/complex/real' );
+var imag = require( '@stdlib/complex/imag' );
+var parseComplex64 = require( './../lib' );
+
+var str = '-0.5 + 1.25i';
+
+var z = parseComplex64( str );
+console.log( z );
+// => <Complex64>
+
+var bool = ( isComplex64( z ) );
+console.log( bool );
+// => true
+
+bool = ( real( z ) === -0.5 );
+console.log( bool );
+// => true
+
+bool = ( imag( z ) === 1.25 );
+console.log( bool );
+// => true
diff --git a/lib/node_modules/@stdlib/complex/parse-float32/lib/index.js b/lib/node_modules/@stdlib/complex/parse-float32/lib/index.js
@@ -0,0 +1,42 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+/**
+* Parse a string representation of a complex number and returns a Complex64 instance.
+*
+* @module @stdlib/complex/parse-float32
+*
+* @example
+* var parseComplex64 = require( '@stdlib/complex/parse-float32' );
+*
+* var str = '1 + 2i';
+*
+* var z = parseComplex64( str );
+* // returns <Complex64>
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;