Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/array/zero-to-like/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ The function recognizes the following data types:

- `float64`: double-precision floating-point numbers (IEEE 754)
- `float32`: single-precision floating-point numbers (IEEE 754)
- `float16`: half-precision floating-point numbers (IEEE 754)
- `complex128`: double-precision complex floating-point numbers
- `complex64`: single-precision complex floating-point numbers
- `int32`: 32-bit two's complement signed integers
Expand Down
22 changes: 22 additions & 0 deletions lib/node_modules/@stdlib/array/zero-to-like/benchmark/benchmark.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,28 @@ bench( format( '%s:dtype=float32', pkg ), function benchmark( b ) {
b.end();
});

bench( format( '%s:dtype=float16', pkg ), function benchmark( b ) {
var arr;
var x;
var i;

x = empty( 0, 'float16' );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
arr = zeroToLike( x );
if ( arr.length !== 0 ) {
b.fail( 'should have length 0' );
}
}
b.toc();
if ( !isTypedArrayLike( arr ) ) {
b.fail( 'should return a typed array' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( format( '%s:dtype=complex128', pkg ), function benchmark( b ) {
var arr;
var x;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/**
* @license Apache-2.0
*
* 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.
* 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 bench = require( '@stdlib/bench' );
var pow = require( '@stdlib/math/base/special/pow' );
var isTypedArray = require( '@stdlib/assert/is-typed-array' );
var empty = require( '@stdlib/array/empty' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var zeroToLike = require( './../lib' );


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = empty( len, 'float16' );
return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var arr;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
arr = zeroToLike( x );
if ( arr.length !== len ) {
b.fail( 'unexpected length' );
}
}
b.toc();
if ( !isTypedArray( arr ) ) {
b.fail( 'should return a typed array' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:dtype=float16,len=%d', pkg, len ), f );
}
}

main();
1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/array/zero-to-like/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

- float64: double-precision floating-point numbers (IEEE 754).
- float32: single-precision floating-point numbers (IEEE 754).
- float16: half-precision floating-point numbers (IEEE 754).
- complex128: double-precision complex floating-point numbers.
- complex64: single-precision complex floating-point numbers.
- int32: 32-bit two's complement signed integers.
Expand Down
36 changes: 36 additions & 0 deletions lib/node_modules/@stdlib/array/zero-to-like/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,24 @@
*/
declare function zeroToLike( x: AnyArray, dtype: 'float32' ): Float32Array;

/**
* Generates a linearly spaced numeric array whose elements increment by 1 starting from zero and having the same length as a provided input array.
*
* @param x - input array from which to derive the output array length
* @param dtype - data type
* @returns linearly spaced numeric array
*
* @example
* var zeros = require( '@stdlib/array/zeros' );
*
* var x = zeros( 2, 'float64' );
* // returns <Float64Array>[ 0.0, 0.0 ]
*
* var y = zeroToLike( x, 'float16' );
* // returns <Float16Array>[ 0.0, 1.0 ]
*/
declare function zeroToLike( x: AnyArray, dtype: 'float16' ): Float16Array;

/**
* Generates a linearly spaced numeric array whose elements increment by 1 starting from zero and having the same length as a provided input array.
*
Expand Down Expand Up @@ -282,6 +300,24 @@
*/
declare function zeroToLike( x: Float32Array, dtype?: NumericDataType ): Float32Array;

/**
* Generates a linearly spaced numeric array whose elements increment by 1 starting from zero and having the same length and data type as a provided input array.
*
* @param x - input array from which to derive the output array length
* @param dtype - data type
* @returns linearly spaced numeric array
*
* @example
* var zeros = require( '@stdlib/array/zeros' );
*
* var x = zeros( 2, 'float16' );
* // returns <Float16Array>[ 0.0, 0.0 ]
*
* var y = zeroToLike( x );
* // returns <Float16Array>[ 0.0, 1.0 ]
*/
declare function zeroToLike( x: Float16Array, dtype?: NumericDataType ): Float16Array;

/**
* Generates a linearly spaced numeric array whose elements increment by 1 starting from zero and having the same length and data type as a provided input array.
*
Expand Down Expand Up @@ -468,7 +504,7 @@
* var y = zeroToLike( x );
* // returns [ 0, 1 ]
*/
declare function zeroToLike( x: Array<any>, dtype?: NumericDataType ): Array<number>;

Check warning on line 507 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Unexpected any. Specify a different type

/**
* Generates a linearly spaced numeric array whose elements increment by 1 starting from zero and having the same length and data type as a provided input array.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,23 @@

// The function returns an array or typed array...
{
zeroToLike( [ 0, 0 ] ); // $ExpectType number[]

Check failure on line 28 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: number[], got: any
zeroToLike( new Float64Array( [ 0, 0 ] ) ); // $ExpectType Float64Array
zeroToLike( new Float32Array( [ 0, 0 ] ) ); // $ExpectType Float32Array
zeroToLike( new Float16Array( [ 0, 0 ] ) ); // $ExpectType Float16Array

Check failure on line 31 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: Float16Array, got: any
zeroToLike( new Complex128Array( [ 0, 0 ] ) ); // $ExpectType Complex128Array

Check failure on line 32 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: Complex128Array, got: any
zeroToLike( new Complex64Array( [ 0, 0 ] ) ); // $ExpectType Complex64Array

Check failure on line 33 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: Complex64Array, got: any
zeroToLike( new Int32Array( [ 0, 0 ] ) ); // $ExpectType Int32Array

Check failure on line 34 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: Int32Array, got: any
zeroToLike( new Int16Array( [ 0, 0 ] ) ); // $ExpectType Int16Array

Check failure on line 35 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: Int16Array, got: any
zeroToLike( new Int8Array( [ 0, 0 ] ) ); // $ExpectType Int8Array

Check failure on line 36 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: Int8Array, got: any
zeroToLike( new Uint32Array( [ 0, 0 ] ) ); // $ExpectType Uint32Array

Check failure on line 37 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: Uint32Array, got: any
zeroToLike( new Uint16Array( [ 0, 0 ] ) ); // $ExpectType Uint16Array

Check failure on line 38 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: Uint16Array, got: any
zeroToLike( new Uint8Array( [ 0, 0 ] ) ); // $ExpectType Uint8Array

Check failure on line 39 in lib/node_modules/@stdlib/array/zero-to-like/docs/types/test.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Expected type to be: Uint8Array, got: any
zeroToLike( new Uint8ClampedArray( [ 0, 0 ] ) ); // $ExpectType Uint8ClampedArray

zeroToLike( [ 0, 0 ], 'float64' ); // $ExpectType Float64Array
zeroToLike( [ 0, 0 ], 'float32' ); // $ExpectType Float32Array
zeroToLike( [ 0, 0 ], 'float16' ); // $ExpectType Float16Array
zeroToLike( [ 0, 0 ], 'complex128' ); // $ExpectType Complex128Array
zeroToLike( [ 0, 0 ], 'complex64' ); // $ExpectType Complex64Array
zeroToLike( [ 0, 0 ], 'int32' ); // $ExpectType Int32Array
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/array/zero-to-like/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
"matrix",
"float64array",
"float32array",
"float16array",
"int32array",
"uint32array",
"int16array",
Expand All @@ -83,6 +84,8 @@
"single",
"float",
"single-precision",
"half",
"half-precision",
"float32",
"ieee754",
"integer",
Expand Down
33 changes: 33 additions & 0 deletions lib/node_modules/@stdlib/array/zero-to-like/test/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
var tape = require( 'tape' );
var Float64Array = require( '@stdlib/array/float64' );
var Float32Array = require( '@stdlib/array/float32' );
var Float16Array = require( '@stdlib/array/float16' );
var Int32Array = require( '@stdlib/array/int32' );
var Uint32Array = require( '@stdlib/array/uint32' );
var Int16Array = require( '@stdlib/array/int16' );
Expand Down Expand Up @@ -203,6 +204,38 @@ tape( 'the function returns a filled array (dtype=float32)', function test( t )
t.end();
});

tape( 'the function returns a filled array (float16)', function test( t ) {
var expected;
var arr;
var x;

x = new Float16Array( 5 );
expected = new Float16Array( [ 0.0, 1.0, 2.0, 3.0, 4.0 ] );

arr = zeroToLike( x );
t.strictEqual( instanceOf( arr, Float16Array ), true, 'returns expected value' );
t.strictEqual( arr.length, expected.length, 'returns expected value' );
t.deepEqual( arr, expected, 'returns expected value' );

t.end();
});

tape( 'the function returns a filled array (dtype=float16)', function test( t ) {
var expected;
var arr;
var x;

x = new Float64Array( 5 );
expected = new Float16Array( [ 0.0, 1.0, 2.0, 3.0, 4.0 ] );

arr = zeroToLike( x, 'float16' );
t.strictEqual( instanceOf( arr, Float16Array ), true, 'returns expected value' );
t.strictEqual( arr.length, expected.length, 'returns expected value' );
t.deepEqual( arr, expected, 'returns expected value' );

t.end();
});

tape( 'the function returns a filled array (complex128)', function test( t ) {
var expected;
var arr;
Expand Down
Loading