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
48 changes: 48 additions & 0 deletions lib/node_modules/@stdlib/array/uint64/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,54 @@ var u = arr.get( 100 );
// returns undefined
```

<a name="method-map"></a>

#### Uint64Array.prototype.map( callbackFn\[, thisArg] )

Returns a new array with each element being the result of a provided callback function.

```javascript
var add = require( '@stdlib/number/uint64/base/add' );

function scale( v ) {
return add( v, v );
}

var arr = new Uint64Array( [ 1, 2, 3 ] );

var out = arr.map( scale );
// returns <Uint64Array>[ 2n, 4n, 6n ]
```

The callback function is provided three arguments:

- **value**: current array element.
- **index**: current array element index.
- **arr**: the array on which this method was called.

To set the function execution context, provide a `thisArg`.

```javascript
var add = require( '@stdlib/number/uint64/base/add' );

function scale( v ) {
this.count += 1;
return add( v, v );
}

var arr = new Uint64Array( [ 1, 2, 3 ] );

var context = {
'count': 0
};

var out = arr.map( scale, context );
// returns <Uint64Array>[ 2n, 4n, 6n ]

var count = context.count;
// returns 3
```

<a name="method-set"></a>

#### Uint64Array.prototype.set( value\[, i] )
Expand Down
84 changes: 84 additions & 0 deletions lib/node_modules/@stdlib/array/uint64/benchmark/benchmark.map.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 isUint64Array = require( '@stdlib/assert/is-uint64array' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var Uint64Array = require( './../lib' );


// MAIN //

bench( format( '%s:map', pkg ), function benchmark( b ) {
var arr;
var out;
var i;

arr = new Uint64Array( 10 );

// Benchmark worst case scenario (i.e., every element is visited and written to the output array)...
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = arr.map( fcn );
if ( typeof out !== 'object' ) {
b.fail( 'should return an object' );
}
}
b.toc();
if ( !isUint64Array( out ) ) {
b.fail( 'should return a Uint64Array' );
}
b.pass( 'benchmark finished' );
b.end();

function fcn( v ) {
return v;
}
});

bench( format( '%s::this_context:map', pkg ), function benchmark( b ) {
var arr;
var out;
var i;

arr = new Uint64Array( 10 );

// Benchmark worst case scenario (i.e., every element is visited and written to the output array)...
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = arr.map( fcn, {} );
if ( typeof out !== 'object' ) {
b.fail( 'should return an object' );
}
}
b.toc();
if ( !isUint64Array( out ) ) {
b.fail( 'should return a Uint64Array' );
}
b.pass( 'benchmark finished' );
b.end();

function fcn( v ) {
return v;
}
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 isUint64Array = require( '@stdlib/assert/is-uint64array' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var Uint64Array = require( './../lib' );


// FUNCTIONS //

/**
* Callback function.
*
* @private
* @param {Uint64} value - array element
* @returns {Uint64} transformed value
*/
function fcn( value ) {
return value;
}

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var arr = new Uint64Array( len );
return benchmark;

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

// Benchmark worst case scenario (i.e., every element is visited and written to the output array)...
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = arr.map( fcn );
if ( typeof out !== 'object' ) {
b.fail( 'should return an object' );
}
}
b.toc();
if ( !isUint64Array( out ) ) {
b.fail( 'should return a Uint64Array' );
}
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:map:len=%d', pkg, len ), f );
}
}

main();
34 changes: 34 additions & 0 deletions lib/node_modules/@stdlib/array/uint64/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,40 @@
<Uint64>[ 2n ]


{{alias}}.prototype.map( clbk[, thisArg] )
Returns a new array with each element being the result of a provided
callback function.

A callback function is provided the following arguments:

- value: current array element.
- index: current array element index.
- arr: the array on which the method was called.

The returned array has the same data type as the host array.

Parameters
----------
clbk: Function
Function which maps array elements to elements in the new array.

thisArg: any (optional)
Execution context.

Returns
-------
out: Uint64Array
A new typed array.

Examples
--------
> function clbk( v ) { return v; };
> var arr = new {{alias}}( [ 1, 2 ] )
<Uint64Array>[ 1n, 2n ]
> var out = arr.map( clbk )
<Uint64Array>[ 1n, 2n ]


{{alias}}.prototype.set( v[, i] )
Sets one or more array elements.

Expand Down
21 changes: 21 additions & 0 deletions lib/node_modules/@stdlib/array/uint64/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import ArrayBuffer = require( '@stdlib/array/buffer' );

// Define a union type representing both iterable and non-iterable iterators:
type Iterator = Iter | IterableIterator;

Check failure on line 31 in lib/node_modules/@stdlib/array/uint64/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

'Iterator' is defined but never used

// Define a type representing a value from which a 64-bit unsigned integer can be derived:
type Uint = Uint64 | bigint | number;
Expand All @@ -36,7 +36,7 @@
/**
* Locale-specific configuration options.
*/
interface LocaleOptions<T = unknown> {

Check failure on line 39 in lib/node_modules/@stdlib/array/uint64/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

'LocaleOptions' is defined but never used
/**
* Configuration property.
*/
Expand Down Expand Up @@ -118,7 +118,7 @@
* @param arr - array on which the method was called
* @returns boolean indicating whether an element in an array passes a test
*/
type Predicate<U> = NullaryPredicate<U> | UnaryPredicate<U> | BinaryPredicate<U> | TernaryPredicate<U>;

Check failure on line 121 in lib/node_modules/@stdlib/array/uint64/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

'Predicate' is defined but never used

/**
* Callback invoked for each element in an array.
Expand Down Expand Up @@ -162,7 +162,7 @@
* @param arr - array on which the method was called
* @returns undefined
*/
type Callback<U> = NullaryCallback<U> | UnaryCallback<U> | BinaryCallback<U> | TernaryCallback<U>;

Check failure on line 165 in lib/node_modules/@stdlib/array/uint64/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

'Callback' is defined but never used

/**
* Callback invoked for each element in an array.
Expand Down Expand Up @@ -260,7 +260,7 @@
* @param arr - array on which the method was called
* @returns accumulated result
*/
type Reducer<U> = NullaryReducer<U> | UnaryReducer<U> | BinaryReducer<U> | TernaryReducer<U> | QuaternaryReducer<U>;

Check failure on line 263 in lib/node_modules/@stdlib/array/uint64/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

'Reducer' is defined but never used

/**
* Comparator function.
Expand All @@ -269,7 +269,7 @@
* @param b - second value for comparison
* @returns number indicating comparison result
*/
type CompareFcn = ( a: Uint64, b: Uint64 ) => number;

Check failure on line 272 in lib/node_modules/@stdlib/array/uint64/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

'CompareFcn' is defined but never used

/**
* Class for creating a 64-bit unsigned integer array.
Expand Down Expand Up @@ -477,6 +477,27 @@
*/
get( i: number ): Uint64 | void;

/**
* Returns a new array with each element being the result of a provided callback function.
*
* @param fcn - callback function
* @param thisArg - execution context
* @returns new array containing transformed elements
*
* @example
* var add = require( '@stdlib/number/uint64/base/add' );
*
* function scale( v ) {
* return add( v, v );
* }
*
* var arr = new Uint64Array( [ 1, 2, 3 ] );
*
* var out = arr.map( scale );
* // returns <Uint64Array>[ 2n, 4n, 6n ]
*/
map<U = unknown>( fcn: MapFcn<U>, thisArg?: ThisParameterType<MapFcn<U>> ): Uint64Array;

/**
* Sets an array element.
*
Expand Down
60 changes: 60 additions & 0 deletions lib/node_modules/@stdlib/array/uint64/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -740,6 +740,66 @@
return getUint64( this._buffer, idx );
});

/**
* Returns a new array with each element being the result of a provided callback function.
*
* @name map
* @memberof Uint64Array.prototype
* @type {Function}
* @param {Function} fcn - callback function
* @param {*} [thisArg] - callback function execution context
* @throws {TypeError} `this` must be a 64-bit unsigned integer array
* @throws {TypeError} first argument must be a function
* @throws {TypeError} callback must return either a 64-bit unsigned integer or a value which can be converted to a 64-bit unsigned integer
* @returns {Uint64Array} 64-bit unsigned integer array
*
* @example
* var add = require( '@stdlib/number/uint64/base/add' );
*
* function scale( v ) {
* return add( v, v );
* }
*
* var arr = new Uint64Array( [ 1, 2, 3 ] );
*
* var out = arr.map( scale );
* // returns <Uint64Array>[ 2n, 4n, 6n ]
*/
setReadOnly( Uint64Array.prototype, 'map', function map( fcn, thisArg ) {
var outbuf;
var words;
var buf;
var out;
var idx;
var i;
var v;
if ( !isUint64Array( this ) ) {
throw new TypeError( 'invalid invocation. `this` is not a 64-bit unsigned integer array.' );
}
if ( !isFunction( fcn ) ) {
throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', fcn ) );
}
buf = this._buffer;
out = new this.constructor( this._length );
outbuf = out._buffer; // eslint-disable-line no-underscore-dangle
words = [ 0, 0 ];
for ( i = 0; i < this._length; i++ ) {
v = fcn.call( thisArg, getUint64( buf, i ), i, this );
if ( !isUint64( v ) ) {
try {
v = new Uint64( v );
} catch ( err ) { // eslint-disable-line no-unused-vars
throw new TypeError( format( 'invalid argument. Callback must return either a 64-bit unsigned integer or a value which can be converted to a 64-bit unsigned integer. Value: `%s`.', v ) );
}
}
toWords( v, words, 1, 0 );
idx = 2 * i;
outbuf[ idx+indices.HIGH ] = words[ 0 ];
outbuf[ idx+indices.LOW ] = words[ 1 ];
}
return out;
});

/**
* Number of array elements.
*
Expand Down Expand Up @@ -839,7 +899,7 @@
buf[ idx+indices.LOW ] = words[ 1 ];
return;
}
if ( isNonNegativeInteger( value ) || ( isBigInt( value ) && isNonNegativeInteger( Number( value ) ) ) ) {

Check warning on line 902 in lib/node_modules/@stdlib/array/uint64/lib/main.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

This line has a length of 110. Maximum allowed is 80
if ( idx >= this._length ) {
throw new RangeError( format( 'invalid argument. Index argument is out-of-bounds. Value: `%u`.', idx ) );
}
Expand Down
Loading
Loading