@stdlib/array-complex64 0.0.2 → 0.0.6

package/docs/types/index.d.ts

@@ -21,10 +21,9 @@
 /// <reference types="@stdlib/types"/>
 
 import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
-import { ArrayLike, TypedArray } from '@stdlib/types/array';
-import { ComplexLike } from '@stdlib/types/object';
+import { ArrayLike, RealOrComplexTypedArray, Complex64Array as Complex64ArrayInterface } from '@stdlib/types/array';
+import { ComplexLike, Complex64 } from '@stdlib/types/object';
 import ArrayBuffer = require( '@stdlib/array-buffer' );
-import Complex64 = require( '@stdlib/complex-float32' );
 
 // Define a union type representing both iterable and non-iterable iterators:
 type Iterator = Iter | IterableIterator;
@@ -32,7 +31,7 @@ type Iterator = Iter | IterableIterator;
 /**
 * Class for creating a 64-bit complex number array.
 */
-declare class Complex64Array {
+declare class Complex64Array implements Complex64ArrayInterface {
 	/**
 	* 64-bit complex number array constructor.
 	*
@@ -100,7 +99,7 @@ declare class Complex64Array {
 	* var len = arr.length;
 	* // returns 2
 	*/
-	constructor( arg?: number | TypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ); // tslint:disable-line:max-line-length
+	constructor( arg?: number | RealOrComplexTypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ); // tslint:disable-line:max-line-length
 
 	/**
 	* Length (in bytes) of the array.
@@ -133,7 +132,7 @@ declare class Complex64Array {
 	* var nbytes = arr.BYTES_PER_ELEMENT;
 	* // returns 8
 	*/
-	readonly BYTES_PER_ELEMENT: number;
+	readonly BYTES_PER_ELEMENT: 8;
 
 	/**
 	* Number of array elements.
@@ -156,8 +155,8 @@ declare class Complex64Array {
 	*
 	* @example
 	* var Complex64 = require( `@stdlib/complex/float32` );
-	* var real = require( `@stdlib/complex/real` );
-	* var imag = require( `@stdlib/complex/imag` );
+	* var realf = require( `@stdlib/complex/realf` );
+	* var imagf = require( `@stdlib/complex/imagf` );
 	*
 	* var arr = new Complex64Array( 4 );
 	*
@@ -173,10 +172,10 @@ declare class Complex64Array {
 	* // Get the last array element:
 	* var z = arr.get( 3 );
 	*
-	* var re = real( z );
+	* var re = realf( z );
 	* // returns 2.0
 	*
-	* var im = imag( z );
+	* var im = imagf( z );
 	* // returns 2.0
 	*/
 	copyWithin( target: number, start: number, end?: number ): Complex64Array;
@@ -234,27 +233,6 @@ declare class Complex64Array {
 	*/
 	get( i: number ): Complex64 | void;
 
-	/**
-	* Returns an array element.
-	*
-	* @param out - output array
-	* @param i - element index
-	* @throws index argument must be a nonnegative integer
-	* @returns array element
-	*
-	* @example
-	* var arr = new Complex64Array( 10 );
-	*
-	* var z = arr.get( 0 );
-	* // returns <Complex64>
-	*
-	* arr.set( [ 1.0, -1.0 ], 0 );
-	*
-	* z = arr.get( [ 0.0, 0.0 ], 0 );
-	* // returns [ 1.0, -1.0 ]
-	*/
-	get( out: ArrayLike<number>, i: number ): ArrayLike<number> | void;
-
 	/**
 	* Sets an array element.
 	*
@@ -287,18 +265,18 @@ declare class Complex64Array {
 	* @throws target array lacks sufficient storage to accommodate source values
 	*
 	* @example
-	* var real = require( `@stdlib/complex/real` );
-	* var imag = require( `@stdlib/complex/imag` );
+	* var realf = require( `@stdlib/complex/realf` );
+	* var imagf = require( `@stdlib/complex/imagf` );
 	*
 	* var arr = new Complex64Array( 10 );
 	*
 	* var z = arr.get( 0 );
 	* // returns <Complex64>
 	*
-	* var re = real( z );
+	* var re = realf( z );
 	* // returns 0.0
 	*
-	* var im = imag( z );
+	* var im = imagf( z );
 	* // returns 0.0
 	*
 	* arr.set( [ 1.0, -1.0 ], 0 );
@@ -306,19 +284,19 @@ declare class Complex64Array {
 	* z = arr.get( 0 );
 	* // returns <Complex64>
 	*
-	* re = real( z );
+	* re = realf( z );
 	* // returns 1.0
 	*
-	* im = imag( z );
+	* im = imagf( z );
 	* // returns -1.0
 	*/
-	set( value: ArrayLike<number | ComplexLike> | Complex64Array | ComplexLike, i?: number ): void; // tslint:disable-line:max-line-length
+	set( value: ArrayLike<number | ComplexLike> | RealOrComplexTypedArray | ComplexLike, i?: number ): void; // tslint:disable-line:max-line-length
 }
 
 /**
 * Interface defining a 64-bit complex number array constructor which is both "newable" and "callable".
 */
-interface Constructor {
+interface Complex64ArrayConstructor {
 	/**
 	* 64-bit complex number array constructor.
 	*
@@ -386,7 +364,7 @@ interface Constructor {
 	* var len = arr.length;
 	* // returns 2
 	*/
-	new( arg?: number | TypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ): Complex64Array; // tslint-disable-line max-line-length
+	new( arg?: number | RealOrComplexTypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ): Complex64Array; // tslint-disable-line max-line-length
 
 	/**
 	* 64-bit complex number array constructor.
@@ -455,7 +433,7 @@ interface Constructor {
 	* var len = arr.length;
 	* // returns 2
 	*/
-	( arg?: number | TypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ): Complex64Array; // tslint-disable-line max-line-length
+	( arg?: number | RealOrComplexTypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ): Complex64Array; // tslint-disable-line max-line-length
 
 	/**
 	* Constructor name.
@@ -464,7 +442,7 @@ interface Constructor {
 	* var str = Complex64Array.name;
 	* // returns 'Complex64Array'
 	*/
-	readonly name: string;
+	readonly name: 'Complex64Array';
 
 	/**
 	* Size (in bytes) of each array element.
@@ -473,7 +451,7 @@ interface Constructor {
 	* var nbytes = Complex64Array.BYTES_PER_ELEMENT;
 	* // returns 8
 	*/
-	readonly BYTES_PER_ELEMENT: number;
+	readonly BYTES_PER_ELEMENT: 8;
 
 	/**
 	* Creates a new 64-bit complex number array from an array-like object or an iterable.
@@ -504,11 +482,11 @@ interface Constructor {
 	*
 	* @example
 	* var Complex64 = require( `@stdlib/complex/float32` );
-	* var real = require( `@stdlib/complex/real` );
-	* var imag = require( `@stdlib/complex/imag` );
+	* var realf = require( `@stdlib/complex/realf` );
+	* var imagf = require( `@stdlib/complex/imagf` );
 	*
 	* function clbk( v ) {
-	*     return new Complex64( real(v)*2.0, imag(v)*2.0 );
+	*     return new Complex64( realf(v)*2.0, imagf(v)*2.0 );
 	* }
 	*
 	* var arr = Complex64Array.from( [ new Complex64( 1.0, 1.0 ) ], clbk );
@@ -517,7 +495,7 @@ interface Constructor {
 	* var len = arr.length;
 	* // returns 1
 	*/
-	from( src: ArrayLike<number | ComplexLike> | Iterable<number | ComplexLike>, clbk?: Function, thisArg?: any ): Complex64Array; // tslint:disable-line:max-line-length
+	from( src: ArrayLike<number | ComplexLike> | RealOrComplexTypedArray | Iterable<number | ComplexLike>, clbk?: Function, thisArg?: any ): Complex64Array; // tslint:disable-line:max-line-length
 
 	/**
 	* Creates a new 64-bit complex number array from a variable number of arguments.
@@ -602,7 +580,7 @@ interface Constructor {
 * var len = arr.length;
 * // returns 2
 */
-declare var ctor: Constructor;
+declare var ctor: Complex64ArrayConstructor;
 
 
 // EXPORTS //

package/docs/types/test.ts

@@ -21,11 +21,11 @@
 import Complex64Array = require( './index' );
 import Complex64 = require( '@stdlib/complex-float32' );
 import ArrayBuffer = require( '@stdlib/array-buffer' );
-import real = require( '@stdlib/complex-real' );
-import imag = require( '@stdlib/complex-imag' );
+import realf = require( '@stdlib/complex-realf' );
+import imagf = require( '@stdlib/complex-imagf' );
 
 const clbk = ( v: Complex64 ) => {
-	return new Complex64( real( v ) * 2.0, imag( v ) * 2.0 );
+	return new Complex64( realf( v ) * 2.0, imagf( v ) * 2.0 );
 };
 
 

package/lib/from_array.js

@@ -21,8 +21,8 @@
 // MODULES //
 
 var isComplexLike = require( '@stdlib/assert-is-complex-like' );
-var real = require( '@stdlib/complex-real' );
-var imag = require( '@stdlib/complex-imag' );
+var realf = require( '@stdlib/complex-realf' );
+var imagf = require( '@stdlib/complex-imagf' );
 
 
 // MAIN //
@@ -48,8 +48,8 @@ function fromArray( buf, arr ) {
 		if ( !isComplexLike( v ) ) {
 			return null;
 		}
-		buf[ j ] = real( v );
-		buf[ j+1 ] = imag( v );
+		buf[ j ] = realf( v );
+		buf[ j+1 ] = imagf( v );
 		j += 2; // stride
 	}
 	return buf;

package/lib/from_iterator.js

@@ -22,8 +22,8 @@
 
 var isArrayLikeObject = require( '@stdlib/assert-is-array-like-object' );
 var isComplexLike = require( '@stdlib/assert-is-complex-like' );
-var real = require( '@stdlib/complex-real' );
-var imag = require( '@stdlib/complex-imag' );
+var realf = require( '@stdlib/complex-realf' );
+var imagf = require( '@stdlib/complex-imagf' );
 
 
 // MAIN //
@@ -43,19 +43,17 @@ function fromIterator( it ) {
 	out = [];
 	while ( true ) {
 		v = it.next();
-		z = v.value;
-		if ( z ) {
-			if ( isArrayLikeObject( z ) && z.length >= 2 ) {
-				out.push( z[ 0 ], z[ 1 ] );
-			} else if ( isComplexLike( z ) ) {
-				out.push( real( z ), imag( z ) );
-			} else {
-				return new TypeError( 'invalid argument. An iterator must return either a two-element array containing real and imaginary components or a complex number. Value: `'+z+'`.' );
-			}
-		}
 		if ( v.done ) {
 			break;
 		}
+		z = v.value;
+		if ( isArrayLikeObject( z ) && z.length >= 2 ) {
+			out.push( z[ 0 ], z[ 1 ] );
+		} else if ( isComplexLike( z ) ) {
+			out.push( realf( z ), imagf( z ) );
+		} else {
+			return new TypeError( 'invalid argument. An iterator must return either a two-element array containing real and imaginary components or a complex number. Value: `'+z+'`.' );
+		}
 	}
 	return out;
 }

package/lib/from_iterator_map.js

@@ -22,8 +22,8 @@
 
 var isArrayLikeObject = require( '@stdlib/assert-is-array-like-object' );
 var isComplexLike = require( '@stdlib/assert-is-complex-like' );
-var real = require( '@stdlib/complex-real' );
-var imag = require( '@stdlib/complex-imag' );
+var realf = require( '@stdlib/complex-realf' );
+var imagf = require( '@stdlib/complex-imagf' );
 
 
 // MAIN //
@@ -46,22 +46,19 @@ function fromIteratorMap( it, clbk, thisArg ) {
 	out = [];
 	i = -1;
 	while ( true ) {
-		i += 1;
 		v = it.next();
-		z = v.value;
-		if ( z ) {
-			z = clbk.call( thisArg, z, i );
-			if ( isArrayLikeObject( z ) && z.length >= 2 ) {
-				out.push( z[ 0 ], z[ 1 ] );
-			} else if ( isComplexLike( z ) ) {
-				out.push( real( z ), imag( z ) );
-			} else {
-				return new TypeError( 'invalid argument. Callback must return either a two-element array containing real and imaginary components or a complex number. Value: `'+z+'`.' );
-			}
-		}
 		if ( v.done ) {
 			break;
 		}
+		i += 1;
+		z = clbk.call( thisArg, v.value, i );
+		if ( isArrayLikeObject( z ) && z.length >= 2 ) {
+			out.push( z[ 0 ], z[ 1 ] );
+		} else if ( isComplexLike( z ) ) {
+			out.push( realf( z ), imagf( z ) );
+		} else {
+			return new TypeError( 'invalid argument. Callback must return either a two-element array containing real and imaginary components or a complex number. Value: `'+z+'`.' );
+		}
 	}
 	return out;
 }

package/lib/index.js

@@ -86,9 +86,9 @@
 
 // MODULES //
 
-var Complex64Array = require( './main.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = Complex64Array;
+module.exports = main;