@stdlib/complex-float32 0.2.1 → 0.3.0

package/docs/types/index.d.ts

@@ -1,7 +1,7 @@
 /*
 * @license Apache-2.0
 *
-* Copyright (c) 2021 The Stdlib Authors.
+* 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.
@@ -18,94 +18,142 @@
 
 // TypeScript Version: 4.1
 
+/* eslint-disable max-lines */
+
+import base = require( '@stdlib/complex-float32-base' );
+import conj = require( '@stdlib/complex-float32-conj' );
+import Complex64 = require( '@stdlib/complex-float32-ctor' );
+import imag = require( '@stdlib/complex-float32-imag' );
+import parseComplex64 = require( '@stdlib/complex-float32-parse' );
+import real = require( '@stdlib/complex-float32-real' );
+import reim = require( '@stdlib/complex-float32-reim' );
+import reviveComplex64 = require( '@stdlib/complex-float32-reviver' );
+
 /**
-* 64-bit complex number.
+* Interface describing the `float32` namespace.
 */
-declare class Complex64 {
+interface Namespace {
+	/**
+	* Base (i.e., lower-level) single-precision complex number functions.
+	*/
+	base: typeof base;
+
 	/**
-	* 64-bit complex number constructor.
+	* Returns the complex conjugate of a single-precision complex floating-point number.
 	*
-	* @param real - real component
-	* @param imag - imaginary component
-	* @returns 64-bit complex number
+	* @param z - complex number
+	* @returns complex conjugate
 	*
 	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	* var realf = require( '@stdlib/complex-float32-real' );
+	* var imagf = require( '@stdlib/complex-float32-imag' );
+	*
 	* var z = new Complex64( 5.0, 3.0 );
+	*
+	* var v = ns.conj( z );
 	* // returns <Complex64>
+	*
+	* var re = realf( v );
+	* // returns 5.0
+	*
+	* var im = imagf( v );
+	* // returns -3.0
 	*/
-	constructor( real: number, imag: number );
+	conj: typeof conj;
 
 	/**
-	* Read-only property returning the real component.
-	*
-	* @returns real component
+	* 64-bit complex number.
 	*/
-	readonly re: number;
+	Complex64: typeof Complex64;
 
 	/**
-	* Read-only property returning the imaginary component.
+	* Returns the imaginary component of a single-precision complex floating-point number.
 	*
+	* @param z - complex number
 	* @returns imaginary component
+	*
+	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var z = new Complex64( 5.0, 3.0 );
+	*
+	* var im = ns.imag( z );
+	* // returns 3.0
 	*/
-	readonly im: number;
+	imag: typeof imag;
 
 	/**
-	* Size (in bytes) of each component.
+	* Parse a string representation of a 64-bit complex number.
 	*
-	* @returns size of each component
+	* @param str - string representation of a complex number
+	* @returns Complex64 instance
+	* @throws must provide a string recognized as a complex number
 	*
 	* @example
-	* var nbytes = Complex64.BYTES_PER_ELEMENT;
-	* // returns 4
+	* var str = '5 + 3i';
+	*
+	* var z = ns.parseComplex64( str );
+	* // returns <Complex64>
 	*/
-	readonly BYTES_PER_ELEMENT: 4;
+	parseComplex64: typeof parseComplex64;
 
 	/**
-	* Length (in bytes) of a complex number.
+	* Returns the real component of a single-precision complex floating-point number.
 	*
-	* @returns byte length
+	* @param z - complex number
+	* @returns real component
 	*
 	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
 	* var z = new Complex64( 5.0, 3.0 );
 	*
-	* var nbytes = z.byteLength;
-	* // returns 8
+	* var re = ns.real( z );
+	* // returns 5.0
 	*/
-	readonly byteLength: 8;
+	real: typeof real;
 
 	/**
-	* Serializes a complex number as a string.
+	* Returns the real and imaginary components of a single-precision complex floating-point number.
 	*
-	* @returns serialized complex number
+	* @param z - complex number
+	* @returns real and imaginary components
 	*
 	* @example
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
 	* var z = new Complex64( 5.0, 3.0 );
 	*
-	* var str = z.toString();
-	* // returns '5 + 3i'
+	* var out = ns.reim( z );
+	* // returns <Float32Array>[ 5.0, 3.0 ]
 	*/
-	toString(): string;
+	reim: typeof reim;
 
 	/**
-	* Serializes a complex number as a JSON object.
-	*
-	* ## Notes
-	*
-	* -   `JSON.stringify()` implicitly calls this method when stringifying a `Complex64` instance.
+	* Revives a JSON-serialized 64-bit complex number.
 	*
-	*
-	* @returns serialized complex number
+	* @param key - key
+	* @param  value - value
+	* @returns value or 64-bit complex number
 	*
 	* @example
-	* var z = new Complex64( 5.0, 3.0 );
+	* var parseJSON = require( '@stdlib/utils-parse-json' );
 	*
-	* var obj = z.toJSON();
-	* // returns { 'type': 'Complex64', 're': 5.0, 'im': 3.0 }
+	* var str = '{"type":"Complex64","re":5,"im":3}';
+	*
+	* var z = parseJSON( str, ns.reviveComplex64 );
+	* // returns <Complex64>
 	*/
-	toJSON(): any;
+	reviveComplex64: typeof reviveComplex64;
 }
 
+/**
+* Single-precision complex number functions.
+*/
+declare var ns: Namespace;
+
 
 // EXPORTS //
 
-export = Complex64;
+export = ns;

package/lib/index.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* 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.
@@ -18,23 +18,97 @@
 
 'use strict';
 
+/*
+* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
+*/
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils-define-read-only-property' );
+
+
+// MAIN //
+
 /**
-* 64-bit complex number constructor.
-*
-* @module @stdlib/complex-float32
+* Top-level namespace.
 *
-* @example
-* var Complex64 = require( '@stdlib/complex-float32' );
-*
-* var z = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
+* @namespace ns
 */
+var ns = {};
 
-// MODULES //
+/**
+* @name base
+* @memberof ns
+* @readonly
+* @type {Namespace}
+* @see {@link module:@stdlib/complex/float32/base}
+*/
+setReadOnly( ns, 'base', require( '@stdlib/complex-float32-base' ) );
+
+/**
+* @name conj
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/conj}
+*/
+setReadOnly( ns, 'conj', require( '@stdlib/complex-float32-conj' ) );
+
+/**
+* @name Complex64
+* @memberof ns
+* @readonly
+* @constructor
+* @see {@link module:@stdlib/complex/float32/ctor}
+*/
+setReadOnly( ns, 'Complex64', require( '@stdlib/complex-float32-ctor' ) );
+
+/**
+* @name imag
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/imag}
+*/
+setReadOnly( ns, 'imag', require( '@stdlib/complex-float32-imag' ) );
+
+/**
+* @name parseComplex64
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/parse}
+*/
+setReadOnly( ns, 'parseComplex64', require( '@stdlib/complex-float32-parse' ) );
 
-var main = require( './main.js' );
+/**
+* @name real
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/real}
+*/
+setReadOnly( ns, 'real', require( '@stdlib/complex-float32-real' ) );
+
+/**
+* @name reim
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/reim}
+*/
+setReadOnly( ns, 'reim', require( '@stdlib/complex-float32-reim' ) );
+
+/**
+* @name reviveComplex64
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/complex/float32/reviver}
+*/
+setReadOnly( ns, 'reviveComplex64', require( '@stdlib/complex-float32-reviver' ) );
 
 
 // EXPORTS //
 
-module.exports = main;
+module.exports = ns;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/complex-float32",
-  "version": "0.2.1",
-  "description": "64-bit complex number.",
+  "version": "0.3.0",
+  "description": "Single-precision complex number functions.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",
@@ -13,12 +13,10 @@
       "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
     }
   ],
-  "main": "./lib",
+  "main": "lib/index.js",
   "directories": {
     "doc": "./docs",
-    "include": "./include",
     "lib": "./lib",
-    "src": "./src",
     "dist": "./dist"
   },
   "types": "./docs/types",
@@ -32,11 +30,15 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-number": "^0.2.1",
-    "@stdlib/number-float64-base-to-float32": "^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.1"
+    "@stdlib/complex-float32-base": "^0.1.0",
+    "@stdlib/complex-float32-conj": "^0.1.1",
+    "@stdlib/complex-float32-ctor": "^0.0.2",
+    "@stdlib/complex-float32-imag": "^0.1.1",
+    "@stdlib/complex-float32-parse": "^0.0.2",
+    "@stdlib/complex-float32-real": "^0.1.1",
+    "@stdlib/complex-float32-reim": "^0.1.2",
+    "@stdlib/complex-float32-reviver": "^0.0.2",
+    "@stdlib/utils-define-read-only-property": "^0.2.2"
   },
   "devDependencies": {},
   "engines": {
@@ -58,16 +60,12 @@
     "stdlib",
     "stdtypes",
     "types",
-    "data",
-    "structure",
     "complex",
-    "complex64",
-    "64-bit",
-    "float32",
-    "float",
-    "single",
-    "single-precision",
-    "ieee754"
+    "cmplx",
+    "number",
+    "namespace",
+    "ns",
+    "float32"
   ],
   "funding": {
     "type": "opencollective",

package/include/stdlib/complex/float32.h

@@ -1,148 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2021 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.
-*/
-
-#ifndef STDLIB_COMPLEX_FLOAT32_H
-#define STDLIB_COMPLEX_FLOAT32_H
-
-#include <complex.h>
-#include <stdint.h>
-
-/*
-* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
-*/
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-// Check for C11 support where we can precisely define a complex number and thus avoid issues concerning infinities and NaNs as real and/or imaginary components... (TODO: revisit the following check; similar to NumPy, we may want to check for a compile time variable (e.g., STDLIB_USE_C99_COMPLEX), rather than checking for C11 support, especially if we are not using C11 functionality)
-#if defined(_Imaginary_I) && defined(CMPLXF)
-
-/**
-* An opaque type definition for a single-precision complex floating-point number.
-*/
-typedef float complex stdlib_complex64_t;
-
-// If we aren't going to use the native complex number type, we need to define a complex number as an "opaque" struct (here, "opaque" meaning type consumers should **not** be accessing the components directly, but only through dedicated functions) for storing the real and imaginary components...
-#else
-
-/**
-* An opaque type definition for a single-precision complex floating-point number.
-*
-* @example
-* stdlib_complex64_t z;
-*
-* // Set the real component:
-* z.re = 5.0f;
-*
-* // Set the imaginary component:
-* z.im = 2.0f;
-*/
-typedef struct {
-	/**
-	* Real component.
-	*/
-	float re;
-
-	/**
-	* Imaginary component.
-	*/
-	float im;
-} stdlib_complex64_t;
-
-#endif
-
-/**
-* An opaque type definition for a union for accessing the real and imaginary parts of a single-precision complex floating-point number.
-*
-* @example
-* float realf( const stdlib_complex64_t z ) {
-*     stdlib_complex64_parts_t v;
-*
-*     // Assign a single-precision complex floating-point number:
-*     v.value = z;
-*
-*     // Extract the real component:
-*     float re = v.parts[ 0 ];
-*
-*     return re;
-* }
-*
-* // ...
-*
-* // Create a complex number:
-* stdlib_complex64_t z = stdlib_complex64( 5.0f, 2.0f );
-*
-* // ...
-*
-* // Access the real component:
-* float re = realf( z );
-* // returns 5.0f
-*/
-typedef union {
-	// An opaque type for the output value (e.g., could be a `struct` or a C99 complex number):
-	stdlib_complex64_t value;
-
-	// Leverage the fact that C99 specifies that complex numbers have the same representation and alignment as a two-element array (see <https://en.cppreference.com/w/c/language/arithmetic_types#Complex_floating_types>), where the first element is the real component and the second element is the imaginary component, thus allowing us to create a complex number irrespective of its native data type (e.g., `struct` vs `float complex`):
-	float parts[ 2 ];
-} stdlib_complex64_parts_t;
-
-/**
-* Returns a single-precision complex floating-point number.
-*/
-stdlib_complex64_t stdlib_complex64( const float real, const float imag );
-
-/**
-* Converts a single-precision floating-point number to a single-precision complex floating-point number.
-*/
-stdlib_complex64_t stdlib_complex64_from_float32( const float real );
-
-/**
-* Converts a double-precision floating-point number to a single-precision complex floating-point number.
-*/
-stdlib_complex64_t stdlib_complex64_from_float64( const double real );
-
-/**
-* Converts (copies) a single-precision complex floating-point number to a single-precision complex floating-point number.
-*/
-stdlib_complex64_t stdlib_complex64_from_complex64( const stdlib_complex64_t z );
-
-/**
-* Converts a signed 8-bit integer to a single-precision complex floating-point number.
-*/
-stdlib_complex64_t stdlib_complex64_from_int8( const int8_t real );
-
-/**
-* Converts an unsigned 8-bit integer to a single-precision complex floating-point number.
-*/
-stdlib_complex64_t stdlib_complex64_from_uint8( const uint8_t real );
-
-/**
-* Converts a signed 16-bit integer to a single-precision complex floating-point number.
-*/
-stdlib_complex64_t stdlib_complex64_from_int16( const int16_t real );
-
-/**
-* Converts an unsigned 16-bit integer to a single-precision complex floating-point number.
-*/
-stdlib_complex64_t stdlib_complex64_from_uint16( const uint16_t real );
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif // !STDLIB_COMPLEX_FLOAT32_H

package/lib/main.js

@@ -1,159 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2018 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 isNumber = require( '@stdlib/assert-is-number' ).isPrimitive;
-var defineProperty = require( '@stdlib/utils-define-property' );
-var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var float64ToFloat32 = require( '@stdlib/number-float64-base-to-float32' );
-var format = require( '@stdlib/string-format' );
-var toStr = require( './tostring.js' );
-var toJSON = require( './tojson.js' );
-
-
-// MAIN //
-
-/**
-* 64-bit complex number constructor.
-*
-* @constructor
-* @param {number} real - real component
-* @param {number} imag - imaginary component
-* @throws {TypeError} must invoke using the `new` keyword
-* @throws {TypeError} real component must be a number
-* @throws {TypeError} imaginary component must be a number
-* @returns {Complex64} 64-bit complex number
-*
-* @example
-* var z = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
-*/
-function Complex64( real, imag ) {
-	if ( !( this instanceof Complex64 ) ) {
-		throw new TypeError( 'invalid invocation. Constructor must be called with the `new` keyword.' );
-	}
-	if ( !isNumber( real ) ) {
-		throw new TypeError( format( 'invalid argument. Real component must be a number. Value: `%s`.', real ) );
-	}
-	if ( !isNumber( imag ) ) {
-		throw new TypeError( format( 'invalid argument. Imaginary component must be a number. Value: `%s`.', imag ) );
-	}
-	defineProperty( this, 're', {
-		'configurable': false,
-		'enumerable': true,
-		'writable': false,
-		'value': float64ToFloat32( real )
-	});
-	defineProperty( this, 'im', {
-		'configurable': false,
-		'enumerable': true,
-		'writable': false,
-		'value': float64ToFloat32( imag )
-	});
-	return this;
-}
-
-/**
-* Size (in bytes) of each component.
-*
-* @name BYTES_PER_ELEMENT
-* @memberof Complex64
-* @type {integer}
-* @returns {integer} size of each component
-*
-* @example
-* var nbytes = Complex64.BYTES_PER_ELEMENT;
-* // returns 4
-*/
-setReadOnly( Complex64, 'BYTES_PER_ELEMENT', 4 );
-
-/**
-* Size (in bytes) of each component.
-*
-* @name BYTES_PER_ELEMENT
-* @memberof Complex64.prototype
-* @type {integer}
-* @returns {integer} size of each component
-*
-* @example
-* var z = new Complex64( 5.0, 3.0 );
-*
-* var nbytes = z.BYTES_PER_ELEMENT;
-* // returns 4
-*/
-setReadOnly( Complex64.prototype, 'BYTES_PER_ELEMENT', 4 );
-
-/**
-* Length (in bytes) of a complex number.
-*
-* @name byteLength
-* @memberof Complex64.prototype
-* @type {integer}
-* @returns {integer} byte length
-*
-* @example
-* var z = new Complex64( 5.0, 3.0 );
-*
-* var nbytes = z.byteLength;
-* // returns 8
-*/
-setReadOnly( Complex64.prototype, 'byteLength', 8 );
-
-/**
-* Serializes a complex number as a string.
-*
-* @name toString
-* @memberof Complex64.prototype
-* @type {Function}
-* @returns {string} serialized complex number
-*
-* @example
-* var z = new Complex64( 5.0, 3.0 );
-*
-* var str = z.toString();
-* // returns '5 + 3i'
-*/
-setReadOnly( Complex64.prototype, 'toString', toStr );
-
-/**
-* Serializes a complex number as a JSON object.
-*
-* ## Notes
-*
-* -   `JSON.stringify()` implicitly calls this method when stringifying a `Complex64` instance.
-*
-* @name toJSON
-* @memberof Complex64.prototype
-* @type {Function}
-* @returns {Object} serialized complex number
-*
-* @example
-* var z = new Complex64( 5.0, 3.0 );
-*
-* var obj = z.toJSON();
-* // returns { 'type': 'Complex64', 're': 5.0, 'im': 3.0 }
-*/
-setReadOnly( Complex64.prototype, 'toJSON', toJSON );
-
-
-// EXPORTS //
-
-module.exports = Complex64;