Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 | 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 504x 504x 504x 148x 148x 148x 148x 148x 148x 148x 148x 504x 504x 22x 22x 22x 22x 22x 22x 22x 22x 95x 95x 95x 22x 22x 22x 22x 22x 22x 22x 22x 22x 158x 158x 158x 158x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 234x 234x 234x 234x 234x 234x 234x 234x 234x 234x 234x 10x 1x 1x 10x 7x 7x 9x 1x 1x 1x 1x 224x 234x 3x 234x 145x 145x 59x 145x 48x 48x 8x 8x 48x 40x 40x 40x 6x 6x 40x 86x 13x 11x 11x 2x 38x 16x 16x 2x 2x 14x 4x 4x 10x 14x 1x 1x 8x 8x 2x 2x 6x 6x 6x 16x 16x 16x 6x 25x 9x 9x 221x 76x 76x 10x 10x 66x 76x 11x 11x 76x 13x 13x 76x 18x 18x 10x 10x 8x 76x 24x 24x 11x 11x 24x 4x 4x 9x 9x 76x 129x 129x 129x 129x 234x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 98x 98x 98x 98x 98x 98x 98x 98x 98x 98x 98x 98x 98x 9x 9x 98x 2x 2x 87x 98x 53x 53x 18x 18x 53x 12x 12x 53x 98x 23x 12x 12x 2x 12x 10x 10x 12x 12x 12x 12x 12x 12x 18x 18x 8x 8x 8x 2x 2x 8x 16x 16x 16x 16x 16x 10x 10x 11x 11x 98x 13x 13x 1x 1x 11x 5x 11x 6x 6x 11x 4x 4x 7x 7x 7x 7x 28x 28x 28x 7x 7x 33x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 16x 16x 16x 10x 10x 16x 1x 1x 5x 16x 13x 13x 5x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 59x 9x 9x 59x 10x 10x 59x 20x 20x 59x 20x 20x 20x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 1x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 3x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 3x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 15x 15x 15x 15x 15x 15x 15x 9x 9x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 5x 5x 6x 6x 6x 6x 6x 6x 6x 6x 6x 24x 24x 24x 8x 8x 8x 8x 16x 16x 16x 16x 16x 24x 6x 6x 6x 6x 6x 6x 6x 6x 6x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 2x 6x 6x 6x 6x 6x 6x 6x 6x 1x 1x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 152x 9x 9x 152x 11x 11x 152x 10x 10x 122x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 318x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 149x 149x 149x 149x 149x 149x 149x 149x 149x 149x 149x 9x 9x 140x 149x 103x 103x 11x 11x 149x 37x 37x 129x 149x 16x 4x 4x 12x 12x 12x 12x 12x 12x 149x 32x 8x 8x 24x 24x 24x 24x 24x 24x 24x 149x 9x 9x 5x 5x 4x 4x 4x 4x 4x 4x 4x 4x 2x 4x 9x 2x 2x 2x 12x 12x 2x 2x 4x 4x 9x 14x 14x 14x 14x 14x 4x 4x 149x 52x 52x 10x 10x 42x 42x 42x 42x 42x 52x 4x 4x 2x 4x 52x 2x 2x 2x 4x 4x 2x 2x 42x 52x 58x 58x 42x 42x 42x 20x 20x 42x 38x 38x 38x 38x 38x 22x 22x 20x 20x 20x 22x 22x 22x 22x 22x 22x | /* eslint-disable no-restricted-syntax, max-lines, no-invalid-this */
/**
* @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 hasIteratorSymbolSupport = require( '@stdlib/assert/has-iterator-symbol-support' );
var isBigInt = require( '@stdlib/assert/is-bigint' ).isPrimitive;
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var isCollection = require( '@stdlib/assert/is-collection' );
var isArrayBuffer = require( '@stdlib/assert/is-arraybuffer' );
var isObject = require( '@stdlib/assert/is-object' );
var isFunction = require( '@stdlib/assert/is-function' );
var isUint64 = require( '@stdlib/assert/is-uint64' );
var isInteger = require( '@stdlib/math/base/assert/is-integer' );
var ITERATOR_SYMBOL = require( '@stdlib/symbol/iterator' );
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var setReadOnlyAccessor = require( '@stdlib/utils/define-nonenumerable-read-only-accessor' );
var accessorGetter = require( '@stdlib/array/base/accessor-getter' );
var getter = require( '@stdlib/array/base/getter' );
var Uint32Array = require( '@stdlib/array/uint32' );
var Number = require( '@stdlib/number/ctor' );
var Uint64 = require( '@stdlib/number/uint64/ctor' );
var toWords = require( '@stdlib/number/uint64/base/to-words' ).assign;
var format = require( '@stdlib/string/format' );
var indices = require( './indices.js' );
var fromIterator = require( './from_iterator.js' );
var fromIteratorMap = require( './from_iterator_map.js' );
var fromArray = require( './from_array.js' );
// VARIABLES //
var BYTES_PER_ELEMENT = Uint32Array.BYTES_PER_ELEMENT * 2;
var HAS_ITERATOR_SYMBOL = hasIteratorSymbolSupport();
// FUNCTIONS //
/**
* Returns a boolean indicating if a value is a 64-bit unsigned integer array.
*
* @private
* @param {*} value - value to test
* @returns {boolean} boolean indicating if a value is a unsigned typed array
*/
function isUint64Array( value ) {
return (
value instanceof Uint64Array ||
(
typeof value === 'object' &&
value !== null &&
value.constructor.name === 'Uint64Array' &&
value.BYTES_PER_ELEMENT === BYTES_PER_ELEMENT &&
typeof value._length === 'number' && // eslint-disable-line no-underscore-dangle
// NOTE: we don't perform a more rigorous test here for a typed array for performance reasons, as robustly checking for a typed array instance could require walking the prototype tree and performing relatively expensive constructor checks...
typeof value._buffer === 'object' // eslint-disable-line no-underscore-dangle
)
);
}
/**
* Returns a boolean indicating if a value is a 64-bit unsigned integer typed array constructor.
*
* @private
* @param {*} value - value to test
* @returns {boolean} boolean indicating if a value is a 64-bit unsigned integer typed array constructor
*/
function isUint64ArrayConstructor( value ) {
return ( value === Uint64Array );
}
/**
* Retrieves a 64-bit unsigned integer from a 32-bit unsigned integer array buffer.
*
* @private
* @param {Uint32Array} buf - array buffer
* @param {NonNegativeInteger} idx - element index
* @returns {Uint64} 64-bit unsigned integer
*/
function getUint64( buf, idx ) {
idx *= 2;
return Uint64.of( buf[ idx+indices.HIGH ], buf[ idx+indices.LOW ] );
}
// MAIN //
/**
* 64-bit unsigned integer array constructor.
*
* @constructor
* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable
* @param {NonNegativeInteger} [byteOffset=0] - byte offset
* @param {NonNegativeInteger} [length] - view length
* @throws {RangeError} ArrayBuffer byte length must be a multiple of `8`
* @throws {TypeError} if provided only a single argument, must provide a valid argument
* @throws {TypeError} byte offset must be a nonnegative integer
* @throws {RangeError} byte offset must be a multiple of `8`
* @throws {TypeError} view length must be a positive multiple of `8`
* @throws {RangeError} must provide sufficient memory to accommodate byte offset and view length requirements
* @throws {TypeError} an array element must be either a 64-bit unsigned integer or a value which can be converted to a 64-bit unsigned integer
* @throws {TypeError} an iterator 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 arr = new Uint64Array();
* // returns <Uint64Array>
*
* var len = arr.length;
* // returns 0
*
* @example
* var arr = new Uint64Array( 2 );
* // returns <Uint64Array>[ 0n, 0n ]
*
* var len = arr.length;
* // returns 2
*
* @example
* var arr = new Uint64Array( [ 1, 2 ] );
* // returns <Uint64Array>[ 1n, 2n ]
*
* var len = arr.length;
* // returns 2
*
* @example
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = new Uint64Array( buf );
* // returns <Uint64Array>[ 0n, 0n, 0n, 0n ]
*
* var len = arr.length;
* // returns 4
*
* @example
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 32 );
* var arr = new Uint64Array( buf, 16 );
* // returns <Uint64Array>[ 0n, 0n ]
*
* var len = arr.length;
* // returns 2
*
* @example
* var ArrayBuffer = require( '@stdlib/array/buffer' );
*
* var buf = new ArrayBuffer( 64 );
* var arr = new Uint64Array( buf, 16, 2 );
* // returns <Uint64Array>[ 0n, 0n ]
*
* var len = arr.length;
* // returns 2
*/
function Uint64Array() {
var byteOffset;
var nargs;
var buf;
var len;
var tmp;
var arg;
var i;
nargs = arguments.length;
if ( !(this instanceof Uint64Array) ) {
if ( nargs === 0 ) {
return new Uint64Array();
}
if ( nargs === 1 ) {
return new Uint64Array( arguments[0] );
}
if ( nargs === 2 ) {
return new Uint64Array( arguments[0], arguments[1] );
}
return new Uint64Array( arguments[0], arguments[1], arguments[2] );
}
// Create the underlying data buffer...
if ( nargs === 0 ) {
buf = new Uint32Array( 0 ); // backward-compatibility
} else if ( nargs === 1 ) {
arg = arguments[ 0 ];
if ( isNonNegativeInteger( arg ) ) {
buf = new Uint32Array( arg*2 );
} else if ( isCollection( arg ) ) {
len = arg.length;
if ( isUint64Array( arg ) ) {
// Source is already arranged as high/low words, so just copy buffer to buffer:
buf = new Uint32Array( arg._buffer ); // eslint-disable-line no-underscore-dangle
} else {
// Assume that every element represents a single 64-bit unsigned integer:
buf = fromArray( new Uint32Array( len*2 ), arg );
if ( buf instanceof Error ) {
throw buf;
}
}
} else if ( isArrayBuffer( arg ) ) {
if ( !isInteger( arg.byteLength/BYTES_PER_ELEMENT ) ) {
throw new RangeError( format( 'invalid argument. ArrayBuffer byte length must be a multiple of %u. Byte length: `%u`.', BYTES_PER_ELEMENT, arg.byteLength ) );
}
buf = new Uint32Array( arg );
} else if ( isObject( arg ) ) {
buf = arg;
if ( HAS_ITERATOR_SYMBOL === false ) {
throw new TypeError( format( 'invalid argument. Environment lacks Symbol.iterator support. Must provide a length, ArrayBuffer, typed array, or array-like object. Value: `%s`.', buf ) );
}
if ( !isFunction( buf[ ITERATOR_SYMBOL ] ) ) {
throw new TypeError( format( 'invalid argument. Must provide a length, ArrayBuffer, typed array, array-like object, or an iterable. Value: `%s`.', buf ) );
}
buf = buf[ ITERATOR_SYMBOL ]();
if ( !isFunction( buf.next ) ) {
throw new TypeError( format( 'invalid argument. Must provide a length, ArrayBuffer, typed array, array-like object, or an iterable. Value: `%s`.', buf ) );
}
buf = fromIterator( buf );
if ( buf instanceof Error ) {
throw buf;
}
len = buf.length;
tmp = new Uint32Array( len );
for ( i = 0; i < len; i += 2 ) {
tmp[ i+indices.HIGH ] = buf[ i ];
tmp[ i+indices.LOW ] = buf[ i+1 ];
}
buf = tmp;
} else {
throw new TypeError( format( 'invalid argument. Must provide a length, ArrayBuffer, typed array, array-like object, or an iterable. Value: `%s`.', arg ) );
}
} else {
buf = arguments[ 0 ];
if ( !isArrayBuffer( buf ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ArrayBuffer. Value: `%s`.', buf ) );
}
byteOffset = arguments[ 1 ];
if ( !isNonNegativeInteger( byteOffset ) ) {
throw new TypeError( format( 'invalid argument. Byte offset must be a nonnegative integer. Value: `%s`.', byteOffset ) );
}
if ( !isInteger( byteOffset/BYTES_PER_ELEMENT ) ) {
throw new RangeError( format( 'invalid argument. Byte offset must be a multiple of %u. Value: `%u`.', BYTES_PER_ELEMENT, byteOffset ) );
}
if ( nargs === 2 ) {
len = buf.byteLength - byteOffset;
if ( !isInteger( len/BYTES_PER_ELEMENT ) ) {
throw new RangeError( format( 'invalid arguments. ArrayBuffer view byte length must be a multiple of %u. View byte length: `%u`.', BYTES_PER_ELEMENT, len ) );
}
buf = new Uint32Array( buf, byteOffset );
} else {
len = arguments[ 2 ];
if ( !isNonNegativeInteger( len ) ) {
throw new TypeError( format( 'invalid argument. Length must be a nonnegative integer. Value: `%s`.', len ) );
}
if ( (len*BYTES_PER_ELEMENT) > (buf.byteLength-byteOffset) ) {
throw new RangeError( format( 'invalid arguments. ArrayBuffer has insufficient capacity. Either decrease the array length or provide a bigger buffer. Minimum capacity: `%u`.', len*BYTES_PER_ELEMENT ) );
}
buf = new Uint32Array( buf, byteOffset, len*2 );
}
}
setReadOnly( this, '_buffer', buf );
setReadOnly( this, '_length', buf.length/2 );
return this;
}
/**
* Size (in bytes) of each array element.
*
* @name BYTES_PER_ELEMENT
* @memberof Uint64Array
* @readonly
* @type {PositiveInteger}
* @default 8
*
* @example
* var nbytes = Uint64Array.BYTES_PER_ELEMENT;
* // returns 8
*/
setReadOnly( Uint64Array, 'BYTES_PER_ELEMENT', BYTES_PER_ELEMENT );
/**
* Constructor name.
*
* @name name
* @memberof Uint64Array
* @readonly
* @type {string}
* @default 'Uint64Array'
*
* @example
* var name = Uint64Array.name;
* // returns 'Uint64Array'
*/
setReadOnly( Uint64Array, 'name', 'Uint64Array' );
/**
* Creates a new 64-bit unsigned integer array from an array-like object or an iterable.
*
* @name from
* @memberof Uint64Array
* @type {Function}
* @param {(Collection|Object)} src - array-like object or iterable
* @param {Function} [clbk] - callback to invoke for each source element
* @param {*} [thisArg] - context
* @throws {TypeError} `this` context must be a constructor
* @throws {TypeError} `this` must be a 64-bit unsigned integer array
* @throws {TypeError} first argument must be an array-like object or an iterable
* @throws {TypeError} second argument must be a function
* @throws {TypeError} an array element must be either a 64-bit unsigned integer or a value which can be converted to a 64-bit unsigned integer
* @throws {TypeError} an iterator must return either a 64-bit unsigned integer or a value which can be converted to a 64-bit unsigned integer
* @throws {TypeError} when provided an iterator, a 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 arr = Uint64Array.from( [ 1, 2, 3 ] );
* // returns <Uint64Array>[ 1n, 2n, 3n ]
*
* var len = arr.length;
* // returns 3
*
* @example
* var Uint64 = require( '@stdlib/number/uint64/ctor' );
*
* var arr = Uint64Array.from( [ new Uint64( 1 ) ] );
* // returns <Uint64Array>[ 1n ]
*
* var len = arr.length;
* // returns 1
*
* @example
* var Uint64 = require( '@stdlib/number/uint64/ctor' );
* var add = require( '@stdlib/number/uint64/base/add' );
*
* function clbk( v ) {
* return add( v, v );
* }
*
* var arr = Uint64Array.from( [ new Uint64( 1 ) ], clbk );
* // returns <Uint64Array>[ 2n ]
*
* var len = arr.length;
* // returns 1
*/
setReadOnly( Uint64Array, 'from', function from( src ) {
var thisArg;
var nargs;
var words;
var clbk;
var out;
var buf;
var tmp;
var get;
var len;
var v;
var i;
var j;
if ( !isFunction( this ) ) {
throw new TypeError( 'invalid invocation. `this` context must be a constructor.' );
}
if ( !isUint64ArrayConstructor( this ) ) {
throw new TypeError( 'invalid invocation. `this` is not a 64-bit unsigned integer array.' );
}
nargs = arguments.length;
if ( nargs > 1 ) {
clbk = arguments[ 1 ];
if ( !isFunction( clbk ) ) {
throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', clbk ) );
}
if ( nargs > 2 ) {
thisArg = arguments[ 2 ];
}
}
if ( isCollection( src ) ) {
if ( clbk ) {
len = src.length;
if ( src.get && src.set ) {
get = accessorGetter( 'default' );
} else {
get = getter( 'default' );
}
out = new this( len );
buf = out._buffer; // eslint-disable-line no-underscore-dangle
words = [ 0, 0 ];
j = 0;
for ( i = 0; i < len; i++ ) {
v = clbk.call( thisArg, get( src, i ), i );
if ( !isUint64( v ) ) {
try {
v = new Uint64( v );
} catch ( err ) { // eslint-disable-line no-unused-vars
throw new TypeError( format( 'invalid argument. A 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 );
buf[ j+indices.HIGH ] = words[ 0 ];
buf[ j+indices.LOW ] = words[ 1 ];
j += 2; // stride
}
return out;
}
return new this( src );
}
if ( isObject( src ) && HAS_ITERATOR_SYMBOL && isFunction( src[ ITERATOR_SYMBOL ] ) ) { // eslint-disable-line max-len
buf = src[ ITERATOR_SYMBOL ]();
if ( !isFunction( buf.next ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an array-like object or an iterable. Value: `%s`.', src ) );
}
if ( clbk ) {
tmp = fromIteratorMap( buf, clbk, thisArg );
} else {
tmp = fromIterator( buf );
}
if ( tmp instanceof Error ) {
throw tmp;
}
len = tmp.length / 2;
out = new this( len );
buf = out._buffer; // eslint-disable-line no-underscore-dangle
for ( i = 0; i < tmp.length; i += 2 ) {
buf[ i+indices.HIGH ] = tmp[ i ];
buf[ i+indices.LOW ] = tmp[ i+1 ];
}
return out;
}
throw new TypeError( format( 'invalid argument. First argument must be an array-like object or an iterable. Value: `%s`.', src ) );
});
/**
* Creates a new 64-bit unsigned integer array from a variable number of arguments.
*
* @name of
* @memberof Uint64Array
* @type {Function}
* @param {...*} element - array elements
* @throws {TypeError} `this` context must be a constructor
* @throws {TypeError} `this` must be a 64-bit unsigned integer array
* @returns {Uint64Array} 64-bit unsigned integer array
*
* @example
* var arr = Uint64Array.of( 1, 2, 3, 4 );
* // returns <Uint64Array>[ 1n, 2n, 3n, 4n ]
*
* var len = arr.length;
* // returns 4
*/
setReadOnly( Uint64Array, 'of', function of() {
var args;
var i;
if ( !isFunction( this ) ) {
throw new TypeError( 'invalid invocation. `this` context must be a constructor.' );
}
if ( !isUint64ArrayConstructor( this ) ) {
throw new TypeError( 'invalid invocation. `this` is not a 64-bit unsigned integer array.' );
}
args = [];
for ( i = 0; i < arguments.length; i++ ) {
args.push( arguments[ i ] );
}
return new this( args );
});
/**
* Returns an array element located at integer position (index) `i`, with support for both nonnegative and negative integer indices.
*
* @name at
* @memberof Uint64Array.prototype
* @type {Function}
* @param {integer} idx - element index
* @throws {TypeError} `this` must be a 64-bit unsigned integer array
* @throws {TypeError} must provide an integer
* @returns {(Uint64|void)} array element
*
* @example
* var arr = new Uint64Array( 10 );
*
* var u = arr.at( 0 );
* // returns <Uint64>[ 0n ]
*
* arr.set( 1, 0 );
* arr.set( 2, 1 );
* arr.set( 9, 9 );
*
* u = arr.at( 0 );
* // returns <Uint64>[ 1n ]
*
* u = arr.at( -1 );
* // returns <Uint64>[ 9n ]
*
* u = arr.at( 100 );
* // returns undefined
*
* u = arr.at( -100 );
* // returns undefined
*/
setReadOnly( Uint64Array.prototype, 'at', function at( idx ) {
if ( !isUint64Array( this ) ) {
throw new TypeError( 'invalid invocation. `this` is not a 64-bit unsigned integer array.' );
}
if ( !isInteger( idx ) ) {
throw new TypeError( format( 'invalid argument. Must provide an integer. Value: `%s`.', idx ) );
}
if ( idx < 0 ) {
idx += this._length;
}
if ( idx < 0 || idx >= this._length ) {
return;
}
return getUint64( this._buffer, idx );
});
/**
* Pointer to the underlying data buffer.
*
* @name buffer
* @memberof Uint64Array.prototype
* @readonly
* @type {ArrayBuffer}
*
* @example
* var arr = new Uint64Array( 10 );
*
* var buf = arr.buffer;
* // returns <ArrayBuffer>
*/
setReadOnlyAccessor( Uint64Array.prototype, 'buffer', function get() {
return this._buffer.buffer;
});
/**
* Size (in bytes) of the array.
*
* @name byteLength
* @memberof Uint64Array.prototype
* @readonly
* @type {NonNegativeInteger}
*
* @example
* var arr = new Uint64Array( 10 );
*
* var byteLength = arr.byteLength;
* // returns 80
*/
setReadOnlyAccessor( Uint64Array.prototype, 'byteLength', function get() {
return this._buffer.byteLength;
});
/**
* Offset (in bytes) of the array from the start of its underlying `ArrayBuffer`.
*
* @name byteOffset
* @memberof Uint64Array.prototype
* @readonly
* @type {NonNegativeInteger}
*
* @example
* var arr = new Uint64Array( 10 );
*
* var byteOffset = arr.byteOffset;
* // returns 0
*/
setReadOnlyAccessor( Uint64Array.prototype, 'byteOffset', function get() {
return this._buffer.byteOffset;
});
/**
* Size (in bytes) of each array element.
*
* @name BYTES_PER_ELEMENT
* @memberof Uint64Array.prototype
* @readonly
* @type {PositiveInteger}
* @default 8
*
* @example
* var arr = new Uint64Array( 10 );
*
* var nbytes = arr.BYTES_PER_ELEMENT;
* // returns 8
*/
setReadOnly( Uint64Array.prototype, 'BYTES_PER_ELEMENT', Uint64Array.BYTES_PER_ELEMENT );
/**
* Returns an iterator for iterating over array key-value pairs.
*
* @name entries
* @memberof Uint64Array.prototype
* @type {Function}
* @throws {TypeError} `this` must be a 64-bit unsigned integer array
* @returns {Iterator} iterator
*
* @example
* var Uint64 = require( '@stdlib/number/uint64/ctor' );
*
* var arr = [
* new Uint64( 1 ),
* new Uint64( 2 ),
* new Uint64( 3 )
* ];
* arr = new Uint64Array( arr );
*
* // Create an iterator:
* var it = arr.entries();
*
* // Iterate over the key-value pairs...
* var v = it.next().value;
* // returns [ 0, <Uint>[ 1n ] ]
*
* v = it.next().value;
* // returns [ 1, <Uint>[ 2n ] ]
*
* v = it.next().value;
* // returns [ 2, <Uint>[ 3n ] ]
*
* var bool = it.next().done;
* // returns true
*/
setReadOnly( Uint64Array.prototype, 'entries', function entries() {
var buffer;
var self;
var iter;
var len;
var FLG;
var i;
if ( !isUint64Array( this ) ) {
throw new TypeError( 'invalid invocation. `this` is not a 64-bit unsigned integer array.' );
}
self = this;
buffer = this._buffer;
len = this._length;
// Initialize the iteration indices:
i = -1;
// Create an iterator protocol-compliant object:
iter = {};
setReadOnly( iter, 'next', next );
setReadOnly( iter, 'return', end );
if ( ITERATOR_SYMBOL ) {
setReadOnly( iter, ITERATOR_SYMBOL, factory );
}
return iter;
/**
* Returns an iterator protocol-compliant object containing the next iterated value.
*
* @private
* @returns {Object} iterator protocol-compliant object
*/
function next() {
var u;
i += 1;
if ( FLG || i >= len ) {
return {
'done': true
};
}
u = new getUint64( buffer, i );
return {
'value': [ i, u ],
'done': false
};
}
/**
* Finishes an iterator.
*
* @private
* @param {*} [value] - value to return
* @returns {Object} iterator protocol-compliant object
*/
function end( value ) {
FLG = true;
if ( arguments.length ) {
return {
'value': value,
'done': true
};
}
return {
'done': true
};
}
/**
* Returns a new iterator.
*
* @private
* @returns {Iterator} iterator
*/
function factory() {
return self.entries();
}
});
/**
* Returns an array element.
*
* @name get
* @memberof Uint64Array.prototype
* @type {Function}
* @param {NonNegativeInteger} idx - element index
* @throws {TypeError} `this` must be a 64-bit unsigned integer array
* @throws {TypeError} must provide a nonnegative integer
* @returns {(Uint64|void)} array element
*
* @example
* var arr = new Uint64Array( 10 );
*
* var z = arr.get( 0 );
* // returns <Uint64>[ 0n ]
*
* arr.set( [ 1 ], 0 );
*
* z = arr.get( 0 );
* // returns <Uint64>[ 1n ]
*
* z = arr.get( 100 );
* // returns undefined
*/
setReadOnly( Uint64Array.prototype, 'get', function get( idx ) {
if ( !isUint64Array( this ) ) {
throw new TypeError( 'invalid invocation. `this` is not a 64-bit unsigned integer array.' );
}
if ( !isNonNegativeInteger( idx ) ) {
throw new TypeError( format( 'invalid argument. Must provide a nonnegative integer. Value: `%s`.', idx ) );
}
if ( idx >= this._length ) {
return;
}
return getUint64( this._buffer, idx );
});
/**
* Number of array elements.
*
* @name length
* @memberof Uint64Array.prototype
* @readonly
* @type {NonNegativeInteger}
*
* @example
* var arr = new Uint64Array( 10 );
*
* var len = arr.length;
* // returns 10
*/
setReadOnlyAccessor( Uint64Array.prototype, 'length', function get() {
return this._length;
});
/**
* Sets an array element.
*
* ## Notes
*
* - When provided a typed array, we must check whether the source array shares the same buffer as the target array and whether the underlying memory overlaps. In particular, we are concerned with the following scenario:
*
* ```text
* buf: ---------------------
* src: ---------------------
* ```
*
* In the above, as we copy values from `src`, we will overwrite values in the `src` view, resulting in duplicated values copied into the end of `buf`, which is not intended. Hence, to avoid overwriting source values, we must **copy** source values to a temporary array.
*
* In the other overlapping scenario,
*
* ```text
* buf: ---------------------
* src: ---------------------
* ```
*
* by the time we begin copying into the overlapping region, we are copying from the end of `src`, a non-overlapping region, which means we don't run the risk of copying copied values, rather than the original `src` values as intended.
*
* @name set
* @memberof Uint64Array.prototype
* @type {Function}
* @param {(Collection|Uint64Array|Uint64|bigint|number)} value - value(s)
* @param {NonNegativeInteger} [i=0] - element index at which to start writing values
* @throws {TypeError} `this` must be a 64-bit unsigned integer array
* @throws {TypeError} index argument must be a nonnegative integer
* @throws {RangeError} index argument is out-of-bounds
* @throws {RangeError} target array lacks sufficient storage to accommodate source values
* @throws {TypeError} an array element must be either a 64-bit unsigned integer or a value which can be converted to a 64-bit unsigned integer
* @throws {TypeError} first argument must be either a 64-bit unsigned integer, a value which can be converted to a 64-bit unsigned integer, a 64-bit unsigned integer array, or an array-like object containing 64-bit unsigned integers or values which can be converted to a 64-bit unsigned integers
* @returns {void}
*
* @example
* var arr = new Uint64Array( 10 );
*
* var z = arr.get( 0 );
* // returns <Uint64>[ 0n ]
*
* arr.set( 1n, 0 );
*
* z = arr.get( 0 );
* // returns <Uint64>[ 1n ]
*/
setReadOnly( Uint64Array.prototype, 'set', function set( value ) {
/* eslint-disable no-underscore-dangle */
var words;
var sbuf;
var idx;
var buf;
var tmp;
var N;
var v;
var i;
var j;
if ( !isUint64Array( this ) ) {
throw new TypeError( 'invalid invocation. `this` is not a 64-bit unsigned integer array.' );
}
buf = this._buffer;
if ( arguments.length > 1 ) {
idx = arguments[ 1 ];
if ( !isNonNegativeInteger( idx ) ) {
throw new TypeError( format( 'invalid argument. Index argument must be a nonnegative integer. Value: `%s`.', idx ) );
}
} else {
idx = 0;
}
words = [ 0, 0 ];
if ( isUint64( value ) ) {
if ( idx >= this._length ) {
throw new RangeError( format( 'invalid argument. Index argument is out-of-bounds. Value: `%u`.', idx ) );
}
idx *= 2;
toWords( value, words, 1, 0 );
buf[ idx+indices.HIGH ] = words[ 0 ];
buf[ idx+indices.LOW ] = words[ 1 ];
return;
}
if ( isNonNegativeInteger( value ) || ( isBigInt( value ) && isNonNegativeInteger( Number( value ) ) ) ) {
if ( idx >= this._length ) {
throw new RangeError( format( 'invalid argument. Index argument is out-of-bounds. Value: `%u`.', idx ) );
}
value = new Uint64( value );
idx *= 2;
toWords( value, words, 1, 0 );
buf[ idx+indices.HIGH ] = words[ 0 ];
buf[ idx+indices.LOW ] = words[ 1 ];
return;
}
if ( isUint64Array( value ) ) {
N = value._length;
if ( idx+N > this._length ) {
throw new RangeError( 'invalid arguments. Target array lacks sufficient storage to accommodate source values.' );
}
sbuf = value._buffer;
// Check for overlapping memory...
j = buf.byteOffset + (idx*BYTES_PER_ELEMENT);
if (
sbuf.buffer === buf.buffer &&
(
sbuf.byteOffset < j &&
sbuf.byteOffset+sbuf.byteLength > j
)
) {
// We need to copy source values...
tmp = new Uint32Array( sbuf.length );
for ( i = 0; i < sbuf.length; i++ ) {
tmp[ i ] = sbuf[ i ];
}
sbuf = tmp;
}
idx *= 2;
j = 0;
for ( i = 0; i < N; i++ ) {
buf[ idx+indices.HIGH ] = sbuf[ j+indices.HIGH ];
buf[ idx+indices.LOW ] = sbuf[ j+indices.LOW ];
idx += 2; // stride
j += 2; // stride
}
return;
}
if ( isCollection( value ) ) {
N = value.length;
if ( idx+N > this._length ) {
throw new RangeError( 'invalid arguments. Target array lacks sufficient storage to accommodate source values.' );
}
sbuf = value;
// Check for overlapping memory...
j = buf.byteOffset + (idx*BYTES_PER_ELEMENT);
if (
sbuf.buffer === buf.buffer &&
(
sbuf.byteOffset < j &&
sbuf.byteOffset+sbuf.byteLength > j
)
) {
// We need to copy source values...
tmp = new Uint32Array( sbuf.length );
for ( i = 0; i < sbuf.length; i++ ) {
tmp[ i ] = sbuf[ i ]; // TODO: handle accessor arrays
}
sbuf = tmp;
}
idx *= 2;
for ( i = 0; i < N; i++ ) {
v = sbuf[ i ];
if ( !isUint64( v ) ) {
try {
v = new Uint64( v );
} catch ( err ) { // eslint-disable-line no-unused-vars
throw new TypeError( format( 'invalid argument. An array element must be 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 );
buf[ idx+indices.HIGH ] = words[ 0 ];
buf[ idx+indices.LOW ] = words[ 1 ];
idx += 2; // stride
}
return;
}
throw new TypeError( format( 'invalid argument. First argument must be either a 64-bit unsigned integer, a value which can be converted to a 64-bit unsigned integer, a 64-bit unsigned integer array, or an array-like object containing 64-bit unsigned integers or values which can be converted to a 64-bit unsigned integers. Value: `%s`.', value ) );
/* eslint-enable no-underscore-dangle */
});
// EXPORTS //
module.exports = Uint64Array;
|