@ohos-ports/stdlib-complex-real 0.0.0-stage → 0.2.1-beta.0

package/node_modules/@stdlib/complex-float32/docs/types/index.d.ts

@@ -0,0 +1,111 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* 64-bit complex number.
+*/
+declare class Complex64 {
+	/**
+	* 64-bit complex number constructor.
+	*
+	* @param real - real component
+	* @param imag - imaginary component
+	* @returns 64-bit complex number
+	*
+	* @example
+	* var z = new Complex64( 5.0, 3.0 );
+	* // returns <Complex64>
+	*/
+	constructor( real: number, imag: number );
+
+	/**
+	* Read-only property returning the real component.
+	*
+	* @returns real component
+	*/
+	readonly re: number;
+
+	/**
+	* Read-only property returning the imaginary component.
+	*
+	* @returns imaginary component
+	*/
+	readonly im: number;
+
+	/**
+	* Size (in bytes) of each component.
+	*
+	* @returns size of each component
+	*
+	* @example
+	* var nbytes = Complex64.BYTES_PER_ELEMENT;
+	* // returns 4
+	*/
+	readonly BYTES_PER_ELEMENT: 4;
+
+	/**
+	* Length (in bytes) of a complex number.
+	*
+	* @returns byte length
+	*
+	* @example
+	* var z = new Complex64( 5.0, 3.0 );
+	*
+	* var nbytes = z.byteLength;
+	* // returns 8
+	*/
+	readonly byteLength: 8;
+
+	/**
+	* Serializes a complex number as a string.
+	*
+	* @returns serialized complex number
+	*
+	* @example
+	* var z = new Complex64( 5.0, 3.0 );
+	*
+	* var str = z.toString();
+	* // returns '5 + 3i'
+	*/
+	toString(): string;
+
+	/**
+	* Serializes a complex number as a JSON object.
+	*
+	* ## Notes
+	*
+	* -   `JSON.stringify()` implicitly calls this method when stringifying a `Complex64` instance.
+	*
+	*
+	* @returns 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 }
+	*/
+	toJSON(): any;
+}
+
+
+// EXPORTS //
+
+export = Complex64;

package/node_modules/@stdlib/complex-float32/include/stdlib/complex/float32.h

@@ -0,0 +1,148 @@
+/**
+* @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/node_modules/@stdlib/complex-float32/lib/index.js

@@ -0,0 +1,40 @@
+/**
+* @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';
+
+/**
+* 64-bit complex number constructor.
+*
+* @module @stdlib/complex-float32
+*
+* @example
+* var Complex64 = require( '@stdlib/complex-float32' );
+*
+* var z = new Complex64( 5.0, 3.0 );
+* // returns <Complex64>
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/node_modules/@stdlib/complex-float32/lib/main.js

@@ -0,0 +1,159 @@
+/**
+* @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;

package/node_modules/@stdlib/complex-float32/lib/tojson.js

@@ -0,0 +1,39 @@
+/**
+* @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';
+
+/**
+* Serializes a complex number as a JSON object.
+*
+* @private
+* @returns {Object} JSON representation
+*/
+function toJSON() {
+	/* eslint-disable no-invalid-this */
+	var out = {};
+	out.type = 'Complex64';
+	out.re = this.re;
+	out.im = this.im;
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = toJSON;

package/node_modules/@stdlib/complex-float32/lib/tostring.js

@@ -0,0 +1,42 @@
+/**
+* @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';
+
+/**
+* Serializes a complex number as a string.
+*
+* @private
+* @returns {string} serialized complex number
+*/
+function toString() { // eslint-disable-line stdlib/no-redeclare
+	/* eslint-disable no-invalid-this */
+	var str = '' + this.re;
+	if ( this.im < 0 ) {
+		str += ' - ' + (-this.im);
+	} else {
+		str += ' + ' + this.im;
+	}
+	str += 'i';
+	return str;
+}
+
+
+// EXPORTS //
+
+module.exports = toString;

package/node_modules/@stdlib/complex-float32/manifest.json

@@ -0,0 +1,38 @@
+{
+	"options": {},
+	"fields": [
+		{
+			"field": "src",
+			"resolve": true,
+			"relative": true
+		},
+		{
+			"field": "include",
+			"resolve": true,
+			"relative": true
+		},
+		{
+			"field": "libraries",
+			"resolve": false,
+			"relative": false
+		},
+		{
+			"field": "libpath",
+			"resolve": true,
+			"relative": false
+		}
+	],
+	"confs": [
+		{
+			"src": [
+				"./src/main.c"
+			],
+			"include": [
+				"./include"
+			],
+			"libraries": [],
+			"libpath": [],
+			"dependencies": []
+		}
+	]
+}

package/node_modules/@stdlib/complex-float32/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@stdlib/complex-float32",
+  "version": "0.2.1",
+  "description": "64-bit complex number.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "doc": "./docs",
+    "include": "./include",
+    "lib": "./lib",
+    "src": "./src",
+    "dist": "./dist"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/complex-float32.git"
+  },
+  "bugs": {
+    "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"
+  },
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdtypes",
+    "types",
+    "data",
+    "structure",
+    "complex",
+    "complex64",
+    "64-bit",
+    "float32",
+    "float",
+    "single",
+    "single-precision",
+    "ieee754"
+  ],
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
+  }
+}