Skip to content
Closed
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/zeros/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ The function recognizes the following data types:
- `int8`: 8-bit two's complement signed integers
- `uint8`: 8-bit unsigned integers
- `uint8c`: 8-bit unsigned integers clamped to `0-255`
- `bool`: boolean values
- `generic`: generic JavaScript values

By default, the output array data type is `float64` (i.e., a [typed array][mdn-typed-array]). To specify an alternative data type, provide a `dtype` argument.
Expand Down
1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/array/zeros/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- int8: 8-bit two's complement signed integers.
- uint8: 8-bit unsigned integers.
- uint8c: 8-bit unsigned integers clamped to 0-255.
- bool: boolean values.
- generic: generic JavaScript values.

The default array data type is `float64`.
Expand Down
5 changes: 3 additions & 2 deletions lib/node_modules/@stdlib/array/zeros/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

/// <reference types="@stdlib/types"/>

import { NumericAndGenericDataTypeMap } from '@stdlib/types/array';
import { DataTypeMap } from '@stdlib/types/array';

/**
* Creates a zero-filled array having a specified length.
Expand All @@ -38,6 +38,7 @@ import { NumericAndGenericDataTypeMap } from '@stdlib/types/array';
* - `int8`: 8-bit two's complement signed integers
* - `uint8`: 8-bit unsigned integers
* - `uint8c`: 8-bit unsigned integers clamped to `0-255`
* - `bool`: boolean values
* - `generic`: generic JavaScript values
*
* @param length - array length
Expand All @@ -52,7 +53,7 @@ import { NumericAndGenericDataTypeMap } from '@stdlib/types/array';
* var arr = zeros( 2, 'float32' );
* // returns <Float32Array>[ 0.0, 0.0 ]
*/
declare function zeros<T extends keyof NumericAndGenericDataTypeMap<number> = 'float64'>( length: number, dtype?: T ): NumericAndGenericDataTypeMap<number>[T];
declare function zeros<U extends keyof DataTypeMap<number> = 'float64'>( length: number, dtype?: U ): DataTypeMap<number>[U];


// EXPORTS //
Expand Down
1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/array/zeros/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import zeros = require( './index' );
zeros( 10, 'uint16' ); // $ExpectType Uint16Array
zeros( 10, 'uint8' ); // $ExpectType Uint8Array
zeros( 10, 'uint8c' ); // $ExpectType Uint8ClampedArray
zeros( 10, 'bool' ); // $ExpectType BooleanArray
zeros( 10, 'generic' ); // $ExpectType number[]
}

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/zeros/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
// VARIABLES //

var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
var DTYPES = dtypes( 'numeric_and_generic' );
var DTYPES = dtypes( 'typed_and_generic' );
var isValidDType = contains( DTYPES );


Expand Down Expand Up @@ -77,7 +77,7 @@
if ( ctor === null ) {
throw new TypeError( format( 'invalid argument. Second argument must be a recognized data type. Value: `%s`.', dtype ) );
}
return new ctor( length ); // WARNING: we assume that, apart from 'generic', the constructors for supported array data types are zero-filled by default

Check warning on line 80 in lib/node_modules/@stdlib/array/zeros/lib/main.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Unexpected 'warning' comment: 'WARNING: we assume that, apart from...'
}


Expand Down
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/array/zeros/test/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ var Uint8Array = require( '@stdlib/array/uint8' );
var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
var Complex64Array = require( '@stdlib/array/complex64' );
var Complex128Array = require( '@stdlib/array/complex128' );
var BooleanArray = require( '@stdlib/array/bool' );
var reinterpret64 = require( '@stdlib/strided/base/reinterpret-complex64' );
var reinterpret128 = require( '@stdlib/strided/base/reinterpret-complex128' );
var instanceOf = require( '@stdlib/assert/instance-of' );
Expand Down Expand Up @@ -309,6 +310,20 @@ tape( 'the function returns a zero-filled array (dtype=uint8c)', function test(
t.end();
});

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

expected = new BooleanArray( [ false, false, false, false, false ] );

arr = zeros( 5, 'bool' );
t.strictEqual( instanceOf( arr, BooleanArray ), 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 zero-filled array (dtype=generic)', function test( t ) {
var expected;
var arr;
Expand Down