Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -256,6 +256,10 @@ A total of 33 issues were closed in this release:
 
 <details>
 
+-   [`f223373`](https://github.com/stdlib-js/stdlib/commit/f223373e1c5b86f2ba763cb92472b03096485604) - **chore:** simplify declarations _(by Athan Reines)_
+-   [`d22a58e`](https://github.com/stdlib-js/stdlib/commit/d22a58eaa5cea695ecb9809f85edea36d1199c74) - **refactor:** simplify declarations _(by Athan Reines)_
+-   [`b66cf8e`](https://github.com/stdlib-js/stdlib/commit/b66cf8efdf5b793040fce1236fa3adcdcd5067a7) - **docs:** update examples _(by Athan Reines)_
+-   [`eb00b1b`](https://github.com/stdlib-js/stdlib/commit/eb00b1b80848018e05fbc2a20d5985e747557977) - **docs:** fix example _(by Athan Reines)_
 -   [`985e111`](https://github.com/stdlib-js/stdlib/commit/985e1117c5836c62d3d9fca351c4815cfa099913) - **docs:** refactor example _(by Athan Reines)_
 -   [`c520b5a`](https://github.com/stdlib-js/stdlib/commit/c520b5a0cae0c85e946f8a646e7cc8c01b3b5673) - **docs:** address TSDoc lint errors and add doctest aliases _(by Philipp Burckhardt)_
 -   [`3f7b1ed`](https://github.com/stdlib-js/stdlib/commit/3f7b1ed405cdb77a3357d424f462e8d3b2276df5) - **docs:** fix code in TSDoc examples _(by Philipp Burckhardt)_

base/copy/README.md

@@ -76,8 +76,6 @@ var bool = ( out === x );
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 var copy = require( '@stdlib/array/base/copy' );
 
 // Create a complex number array:
@@ -88,15 +86,9 @@ var out = copy( arr );
 
 // Retrieve the first element:
 var z = out[ 0 ];
-// returns <Complex64>
+// returns <Complex64>[ 0.0, 0.0 ]
 
-var re = realf( z );
-// returns 0.0
-
-var im = imagf( z );
-// returns 0.0
-
-console.log( '%d + %di', re, im );
+console.log( '%s', z.toString() );
 // => '0 + 0i'
 ```
 

base/copy/examples/index.js

@@ -19,8 +19,6 @@
 'use strict';
 
 var Complex64Array = require( './../../../complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 var copy = require( './../lib' );
 
 // Create a complex number array:
@@ -31,13 +29,7 @@ var out = copy( arr );
 
 // Retrieve the first element:
 var z = out[ 0 ];
-// returns <Complex64>
+// returns <Complex64>[ 0.0, 0.0 ]
 
-var re = realf( z );
-// returns 0.0
-
-var im = imagf( z );
-// returns 0.0
-
-console.log( '%d + %di', re, im );
+console.log( '%s', z.toString() );
 // => '0 + 0i'

base/one-to/docs/types/index.d.ts

@@ -20,7 +20,12 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array';
+import { Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Input array.
+*/
+type InputArray<T> = Collection<T> | AccessorArrayLike<T>;
 
 /**
 * Interface describing `oneTo`.
@@ -54,281 +59,7 @@ interface ZeroTo {
 	* var arr = oneTo.assign( out, 1, 0 );
 	* // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 	*/
-	assign( out: Float64Array, stride: number, offset: number ): Float64Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Float32Array = require( './../../../../float32' );
-	*
-	* var out = new Float32Array( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Float32Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
-	*/
-	assign( out: Float32Array, stride: number, offset: number ): Float32Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Int32Array = require( './../../../../int32' );
-	*
-	* var out = new Int32Array( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Int32Array>[ 1, 2, 3, 4, 5, 6 ]
-	*/
-	assign( out: Int32Array, stride: number, offset: number ): Int32Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Int16Array = require( './../../../../int16' );
-	*
-	* var out = new Int16Array( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Int16Array>[ 1, 2, 3, 4, 5, 6 ]
-	*/
-	assign( out: Int16Array, stride: number, offset: number ): Int16Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Int8Array = require( './../../../../int8' );
-	*
-	* var out = new Int8Array( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Int8Array>[ 1, 2, 3, 4, 5, 6 ]
-	*/
-	assign( out: Int8Array, stride: number, offset: number ): Int8Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Uint32Array = require( './../../../../uint32' );
-	*
-	* var out = new Uint32Array( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Uint32Array>[ 1, 2, 3, 4, 5, 6 ]
-	*/
-	assign( out: Uint32Array, stride: number, offset: number ): Uint32Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Uint16Array = require( './../../../../uint16' );
-	*
-	* var out = new Uint16Array( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Uint16Array>[ 1, 2, 3, 4, 5, 6 ]
-	*/
-	assign( out: Uint16Array, stride: number, offset: number ): Uint16Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Uint8Array = require( './../../../../uint8' );
-	*
-	* var out = new Uint8Array( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Uint8Array>[ 1, 2, 3, 4, 5, 6 ]
-	*/
-	assign( out: Uint8Array, stride: number, offset: number ): Uint8Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Uint8ClampedArray = require( './../../../../uint8c' );
-	*
-	* var out = new Uint8ClampedArray( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Uint8ClampedArray>[ 1, 2, 3, 4, 5, 6 ]
-	*/
-	assign( out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Complex128Array = require( './../../../../complex128' );
-	* var real = require( '@stdlib/complex/float64/real' );
-	* var imag = require( '@stdlib/complex/float64/imag' );
-	*
-	* var out = new Complex128Array( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Complex128Array>
-	*
-	* var bool = ( arr === out );
-	* // returns true
-	*
-	* var v = out.get( out.length-1 );
-	* // returns <Complex128>
-	*
-	* var re = real( v );
-	* // returns 6.0
-	*
-	* var im = imag( v );
-	* // returns 0.0
-	*/
-	assign( out: Complex128Array, stride: number, offset: number ): Complex128Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var Complex64Array = require( './../../../../complex64' );
-	* var realf = require( '@stdlib/complex/float32/real' );
-	* var imagf = require( '@stdlib/complex/float32/imag' );
-	*
-	* var out = new Complex64Array( 6 );
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns <Complex64Array>
-	*
-	* var bool = ( arr === out );
-	* // returns true
-	*
-	* var v = out.get( out.length-1 );
-	* // returns <Complex64>
-	*
-	* var re = realf( v );
-	* // returns 6.0
-	*
-	* var im = imagf( v );
-	* // returns 0.0
-	*/
-	assign( out: Complex64Array, stride: number, offset: number ): Complex64Array;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var toAccessorArray = require( './../../../../base/to-accessor-array' );
-	*
-	* var out = toAccessorArray( [ 0, 0, 0, 0, 0, 0 ] );
-	* var arr = oneTo.assign( out, 1, 0 );
-	*
-	* var bool = ( arr === out );
-	* // returns true
-	*
-	* var v = out.get( out.length-1 );
-	* // returns 6
-	*/
-	assign<T = unknown>( out: AccessorArrayLike<T>, stride: number, offset: number ): AccessorArrayLike<T>;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var out = [ 0, 0, 0, 0, 0, 0 ];
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns [ 1, 2, 3, 4, 5, 6 ]
-	*
-	* @example
-	* var out = [ 0, 0, 0, 0, 0, 0 ];
-	*
-	* var arr = oneTo.assign( out, -1, out.length-1 );
-	* // returns [ 6, 5, 4, 3, 2, 1 ]
-	*/
-	assign<T = unknown>( out: Array<T>, stride: number, offset: number ): Array<T | number>;
-
-	/**
-	* Fills an array with linearly spaced numeric elements which increment by 1 starting from one.
-	*
-	* @param out - output array
-	* @param stride - output array stride
-	* @param offset - output array index offset
-	* @returns output array
-	*
-	* @example
-	* var out = [ 0, 0, 0, 0, 0, 0 ];
-	*
-	* var arr = oneTo.assign( out, 1, 0 );
-	* // returns [ 1, 2, 3, 4, 5, 6 ]
-	*
-	* @example
-	* var out = [ 0, 0, 0, 0, 0, 0 ];
-	*
-	* var arr = oneTo.assign( out, -1, out.length-1 );
-	* // returns [ 6, 5, 4, 3, 2, 1 ]
-	*/
-	assign<T = unknown>( out: Collection<T>, stride: number, offset: number ): Collection<T | number>;
+	assign<T = unknown, U extends InputArray<T> = InputArray<T>>( out: U, stride: number, offset: number ): U;
 }
 
 /**

base/one-to/lib/assign.js

@@ -75,23 +75,17 @@ function indexed( out, stride, offset ) {
 * @returns {(Complex128Array|Complex64Array)} output array
 *
 * @example
-* var Complex128Array = require( '@stdlib/array/complex128' );
 * var reinterpret128 = require( '@stdlib/strided/base/reinterpret-complex128' );
+* var Complex128Array = require( '@stdlib/array/complex128' );
 *
 * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
-* // returns <Complex128Array>
+* // returns <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
 *
-* var data = reinterpret128( out, 0 );
-* // returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
-*
-* var arr = complex( out, data, 1, 0 );
-* // returns <Complex128Array>
+* var arr = complex( out, reinterpret128( out, 0 ), 1, 0 );
+* // returns <Complex128Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ]
 *
 * var bool = ( arr === out );
 * // returns true
-*
-* data = reinterpret128( out, 0 );
-* returns <Float64Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ]
 */
 function complex( out, data, stride, offset ) {
 	var v;