@stdlib/complex-float32 0.2.0 → 0.3.0

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;

package/lib/tojson.js

@@ -1,39 +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';
-
-/**
-* 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/lib/tostring.js

@@ -1,42 +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';
-
-/**
-* 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/manifest.json

@@ -1,38 +0,0 @@
-{
-	"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/src/main.c

@@ -1,151 +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.
-*/
-
-#include "stdlib/complex/float32.h"
-#include <stdint.h>
-
-/**
-* Returns a single-precision complex floating-point number.
-*
-* @param real     real component
-* @param imag     imaginary component
-* @return         single-precision complex floating-point number
-*
-* @example
-* stdlib_complex64_t z = stdlib_complex64( 5.0f, 2.0f );
-*/
-stdlib_complex64_t stdlib_complex64( const float real, const float imag ) {
-	stdlib_complex64_parts_t z;
-	z.parts[ 0 ] = real;
-	z.parts[ 1 ] = imag; // cppcheck-suppress unreadVariable
-	return z.value;
-}
-
-/**
-* Converts a single-precision floating-point number to a single-precision complex floating-point number.
-*
-* @param real    real component
-* @return        single-precision complex floating-point number
-*
-* @example
-* stdlib_complex64_t z = stdlib_complex64_from_float32( 5.0f );
-*/
-stdlib_complex64_t stdlib_complex64_from_float32( const float real ) {
-	stdlib_complex64_parts_t z;
-	z.parts[ 0 ] = real;
-	z.parts[ 1 ] = 0.0f; // cppcheck-suppress unreadVariable
-	return z.value;
-}
-
-/**
-* Converts a double-precision floating-point number to a single-precision complex floating-point number.
-*
-* @param real    real component
-* @return        single-precision complex floating-point number
-*
-* @example
-* stdlib_complex64_t z = stdlib_complex64_from_float64( 5.0 );
-*/
-stdlib_complex64_t stdlib_complex64_from_float64( const double real ) {
-	stdlib_complex64_parts_t z;
-	z.parts[ 0 ] = (float)real;
-	z.parts[ 1 ] = 0.0f; // cppcheck-suppress unreadVariable
-	return z.value;
-}
-
-/**
-* Converts (copies) a single-precision complex floating-point number to a single-precision complex floating-point number.
-*
-* @param z       single-precision complex floating-point number
-* @return        single-precision complex floating-point number
-*
-* @example
-* stdlib_complex64_t z1 = stdlib_complex64( 5.0f, 3.0f );
-* stdlib_complex64_t z2 = stdlib_complex64_from_complex64( z1 );
-*/
-stdlib_complex64_t stdlib_complex64_from_complex64( const stdlib_complex64_t z ) {
-	stdlib_complex64_parts_t v1 = { z };
-	stdlib_complex64_parts_t v2;
-	v2.parts[ 0 ] = v1.parts[ 0 ];
-	v2.parts[ 1 ] = v1.parts[ 1 ]; // cppcheck-suppress unreadVariable
-	return v2.value;
-}
-
-/**
-* Converts a signed 8-bit integer to a single-precision complex floating-point number.
-*
-* @param real    real component
-* @return        single-precision complex floating-point number
-*
-* @example
-* stdlib_complex64_t z = stdlib_complex64_from_int8( 5 );
-*/
-stdlib_complex64_t stdlib_complex64_from_int8( const int8_t real ) {
-	stdlib_complex64_parts_t z;
-	z.parts[ 0 ] = (float)real;
-	z.parts[ 1 ] = 0.0f; // cppcheck-suppress unreadVariable
-	return z.value;
-}
-
-/**
-* Converts an unsigned 8-bit integer to a single-precision complex floating-point number.
-*
-* @param real    real component
-* @return        single-precision complex floating-point number
-*
-* @example
-* stdlib_complex64_t z = stdlib_complex64_from_uint8( 5 );
-*/
-stdlib_complex64_t stdlib_complex64_from_uint8( const uint8_t real ) {
-	stdlib_complex64_parts_t z;
-	z.parts[ 0 ] = (float)real;
-	z.parts[ 1 ] = 0.0f; // cppcheck-suppress unreadVariable
-	return z.value;
-}
-
-/**
-* Converts a signed 16-bit integer to a single-precision complex floating-point number.
-*
-* @param real    real component
-* @return        single-precision complex floating-point number
-*
-* @example
-* stdlib_complex64_t z = stdlib_complex64_from_int16( 5 );
-*/
-stdlib_complex64_t stdlib_complex64_from_int16( const int16_t real ) {
-	stdlib_complex64_parts_t z;
-	z.parts[ 0 ] = (float)real;
-	z.parts[ 1 ] = 0.0f; // cppcheck-suppress unreadVariable
-	return z.value;
-}
-
-/**
-* Converts an unsigned 16-bit integer to a single-precision complex floating-point number.
-*
-* @param real    real component
-* @return        single-precision complex floating-point number
-*
-* @example
-* stdlib_complex64_t z = stdlib_complex64_from_uint16( 5 );
-*/
-stdlib_complex64_t stdlib_complex64_from_uint16( const uint16_t real ) {
-	stdlib_complex64_parts_t z;
-	z.parts[ 0 ] = (float)real;
-	z.parts[ 1 ] = 0.0f; // cppcheck-suppress unreadVariable
-	return z.value;
-}